Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://app.posthog.com
https://eu.posthog.com
/api/projects/{project_id}/actions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| format | query | optional | string | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/actions
/api/projects/{project_id}/actions/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| format | query | optional | string | |
| id | path | required | integer | A unique integer value identifying this action. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/actions/{id}
/api/projects/{project_id}/activity_log
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| cursor | query | optional | string | The pagination cursor value. |
| 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/. |
GET /api/projects/{project_id}/activity_log
/api/projects/{project_id}/activity_log/important_changes
| 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/. |
GET /api/projects/{project_id}/activity_log/important_changes
/api/projects/{project_id}/annotations
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
| search | query | optional | string | A search term. |
GET /api/projects/{project_id}/annotations
/api/projects/{project_id}/annotations/{id}
Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this annotation. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/annotations/{id}
/api/projects/{project_id}/app_metrics/{id}
| 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/. |
GET /api/projects/{project_id}/app_metrics/{id}
/api/projects/{project_id}/app_metrics/{id}/error_details
| 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/. |
GET /api/projects/{project_id}/app_metrics/{id}/error_details
/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| plugin_config_id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports
/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | |
| plugin_config_id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/{id}
/api/projects/{project_id}/batch_exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/batch_exports
/api/projects/{project_id}/batch_exports/{batch_export_id}/logs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| batch_export_id | path | required | string | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/batch_exports/{batch_export_id}/logs
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs
Get all BatchExportRuns for a BatchExport.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| batch_export_id | path | required | string | |
| cursor | query | optional | string | The pagination cursor value. |
| 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/. |
GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| batch_export_id | path | required | string | |
| id | path | required | string | A UUID string identifying this batch export run. |
| 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/. |
GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}
/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{run_id}/logs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| batch_export_id | path | required | string | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
| run_id | path | required | string |
GET /api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{run_id}/logs
/api/projects/{project_id}/batch_exports/{id}
| 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/. |
GET /api/projects/{project_id}/batch_exports/{id}
/api/projects/{project_id}/cohorts
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/cohorts
/api/projects/{project_id}/cohorts/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this cohort. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/cohorts/{id}
/api/projects/{project_id}/cohorts/{id}/duplicate_as_static_cohort
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this cohort. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/cohorts/{id}/duplicate_as_static_cohort
/api/projects/{project_id}/cohorts/{id}/persons
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| format | query | optional | string | |
| id | path | required | integer | A unique integer value identifying this cohort. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/cohorts/{id}/persons
/api/projects/{project_id}/dashboard_templates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/dashboard_templates
/api/projects/{project_id}/dashboard_templates/json_schema
| 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/. |
GET /api/projects/{project_id}/dashboard_templates/json_schema
/api/projects/{project_id}/dashboard_templates/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/dashboard_templates/{id}
/api/projects/{project_id}/dashboards
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/dashboards
/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators
| 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/. |
GET /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators
/api/projects/{project_id}/dashboards/{dashboard_id}/sharing
| 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/. |
GET /api/projects/{project_id}/dashboards/{dashboard_id}/sharing
/api/projects/{project_id}/dashboards/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this dashboard. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/dashboards/{id}
/api/projects/{project_id}/early_access_feature
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/early_access_feature
/api/projects/{project_id}/early_access_feature/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this early access feature. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/early_access_feature/{id}
/api/projects/{project_id}/event_definitions
| 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/. |
GET /api/projects/{project_id}/event_definitions
/api/projects/{project_id}/event_definitions/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/event_definitions/{id}
/api/projects/{project_id}/events
This endpoint allows you to list and filter events. It is effectively deprecated and is kept only for backwards compatibility. If you ever ask about it you will be advised to not use it... If you want to ad-hoc list or aggregate events, use the Query endpoint instead. If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| after | query | optional | string | Only return events with a timestamp after this time. |
| before | query | optional | string | Only return events with a timestamp before this time. |
| distinct_id | query | optional | integer | Filter list by distinct id. |
| event | query | optional | string | Filter list by event. For example `user sign up` or `$pageview`. |
| format | query | optional | string | |
| limit | query | optional | integer | The maximum number of results to return |
| offset | query | optional | integer | The initial index from which to return the results. |
| person_id | query | optional | integer | Filter list by person id. |
| 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/. |
| properties | query | optional | array | Filter events by event property, person property, cohort, groups and more. |
| select | query | optional | array | (Experimental) JSON-serialized array of HogQL expressions to return |
| where | query | optional | array | (Experimental) JSON-serialized array of HogQL expressions that must pass |
GET /api/projects/{project_id}/events
/api/projects/{project_id}/events/values
| 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/. |
GET /api/projects/{project_id}/events/values
/api/projects/{project_id}/events/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| format | query | optional | string | |
| id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/events/{id}
/api/projects/{project_id}/experiments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/experiments
/api/projects/{project_id}/experiments/requires_flag_implementation
| 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/. |
GET /api/projects/{project_id}/experiments/requires_flag_implementation
/api/projects/{project_id}/experiments/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this experiment. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/experiments/{id}
/api/projects/{project_id}/experiments/{id}/results
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this experiment. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/experiments/{id}/results
/api/projects/{project_id}/experiments/{id}/secondary_results
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this experiment. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/experiments/{id}/secondary_results
/api/projects/{project_id}/explicit_members
| 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/. |
GET /api/projects/{project_id}/explicit_members
/api/projects/{project_id}/explicit_members/{parent_membership__user__uuid}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| parent_membership__user__uuid | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/explicit_members/{parent_membership__user__uuid}
/api/projects/{project_id}/exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/exports
/api/projects/{project_id}/exports/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this exported asset. |
| 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/. |
GET /api/projects/{project_id}/exports/{id}
/api/projects/{project_id}/exports/{id}/content
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this exported asset. |
| 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/. |
GET /api/projects/{project_id}/exports/{id}/content
/api/projects/{project_id}/feature_flags
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/feature_flags
/api/projects/{project_id}/feature_flags/activity
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/activity
/api/projects/{project_id}/feature_flags/evaluation_reasons
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/evaluation_reasons
/api/projects/{project_id}/feature_flags/local_evaluation
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/local_evaluation
/api/projects/{project_id}/feature_flags/my_flags
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/my_flags
/api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| feature_flag_id | path | required | integer | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access
/api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| feature_flag_id | path | required | integer | |
| id | path | required | integer | A unique integer value identifying this feature flag role access. |
| 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/. |
GET /api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access/{id}
/api/projects/{project_id}/feature_flags/{id}
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/{id}
/api/projects/{project_id}/feature_flags/{id}/activity
Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/user-guides/feature-flags) 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.
| 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/. |
GET /api/projects/{project_id}/feature_flags/{id}/activity
/api/projects/{project_id}/groups
List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| cursor | query | optional | string | The pagination cursor value. |
| group_type_index | query | required | integer | Specify the group type to list |
| 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/. |
| search | query | required | string | Search the group name |
GET /api/projects/{project_id}/groups
/api/projects/{project_id}/groups/find
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_key | query | required | string | Specify the key of the group to find |
| group_type_index | query | required | integer | Specify the group type to find |
| 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/. |
GET /api/projects/{project_id}/groups/find
/api/projects/{project_id}/groups/property_definitions
| 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/. |
GET /api/projects/{project_id}/groups/property_definitions
/api/projects/{project_id}/groups/property_values
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_type_index | query | required | integer | Specify the group type to find property values of |
| key | query | required | string | Specify the property key to find values for |
| 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/. |
GET /api/projects/{project_id}/groups/property_values
/api/projects/{project_id}/groups/related
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| group_type_index | query | required | integer | Specify the group type to find |
| id | query | required | string | Specify the id of the user to find groups for |
| 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/. |
GET /api/projects/{project_id}/groups/related
/api/projects/{project_id}/groups_types
| 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/. |
GET /api/projects/{project_id}/groups_types
/api/projects/{project_id}/insights
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| created_by | query | optional | integer | |
| format | query | optional | string | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | query | optional | string |
GET /api/projects/{project_id}/insights
/api/projects/{project_id}/insights/activity
| 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/. |
GET /api/projects/{project_id}/insights/activity
/api/projects/{project_id}/insights/funnel
| 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/. |
GET /api/projects/{project_id}/insights/funnel
/api/projects/{project_id}/insights/funnel/correlation
| 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/. |
GET /api/projects/{project_id}/insights/funnel/correlation
/api/projects/{project_id}/insights/my_last_viewed
Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.
| 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/. |
GET /api/projects/{project_id}/insights/my_last_viewed
/api/projects/{project_id}/insights/path
| 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/. |
GET /api/projects/{project_id}/insights/path
/api/projects/{project_id}/insights/retention
| 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/. |
GET /api/projects/{project_id}/insights/retention
/api/projects/{project_id}/insights/trend
| 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/. |
GET /api/projects/{project_id}/insights/trend
/api/projects/{project_id}/insights/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| format | query | optional | string | |
| from_dashboard | query | optional | integer | When loading an insight for a dashboard pass a `from_dashboard` query parameter containing the dashboard ID e.g. `"/api/projects/{team_id}/insights/{insight_id}?from_dashboard={dashboard_id}"` Insights can be added to more than one dashboard, this allows the insight to be loaded in the correct context. Using the correct cache and enriching the response with dashboard specific config (e.g. layouts or colors) |
| 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/. |
| refresh | query | optional | boolean | The client can request that an insight be refreshed by setting the `refresh=true` parameter. The server will then decide if the data should or not be refreshed based on a set of heuristics meant to determine the staleness of cached data. The result will contain as `is_cached` field that indicates whether the insight was actually refreshed or not through the request. |
GET /api/projects/{project_id}/insights/{id}
/api/projects/{project_id}/insights/{id}/activity
| 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/. |
GET /api/projects/{project_id}/insights/{id}/activity
/api/projects/{project_id}/insights/{insight_id}/sharing
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| insight_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/. |
GET /api/projects/{project_id}/insights/{insight_id}/sharing
/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.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| contains | query | optional | string | Filter for notebooks that match a provided filter. Each match pair is separated by a colon, multiple match pairs can be sent separated by a space or a comma |
| created_by | query | optional | integer | The UUID of the Notebook's creator |
| date_from | query | optional | string | Filter for notebooks created after this date & time |
| date_to | query | optional | string | Filter for notebooks created before this date & time |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
| user | query | optional | string | If any value is provided for this parameter, return notebooks created by the logged in user. |
GET /api/projects/{project_id}/notebooks
/api/projects/{project_id}/notebooks/activity
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
| 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/. |
GET /api/projects/{project_id}/notebooks/activity
/api/projects/{project_id}/notebooks/{short_id}
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | path | required | string |
GET /api/projects/{project_id}/notebooks/{short_id}
/api/projects/{project_id}/notebooks/{short_id}/activity
The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | path | required | string |
GET /api/projects/{project_id}/notebooks/{short_id}/activity
/api/organizations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
GET /api/organizations
/api/organizations/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this organization. |
GET /api/organizations/{id}
/api/organizations/{organization_id}/batch_exports
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/batch_exports
/api/organizations/{organization_id}/batch_exports/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this batch export. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/batch_exports/{id}
/api/organizations/{organization_id}/domains
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/domains
/api/organizations/{organization_id}/domains/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this domain. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/domains/{id}
/api/organizations/{organization_id}/invites
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/invites
/api/organizations/{organization_id}/members
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/members
/api/organizations/{organization_id}/pipeline_destinations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations
/api/organizations/{organization_id}/pipeline_destinations/activity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/activity
/api/organizations/{organization_id}/pipeline_destinations/exports_unsubscribe_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/exports_unsubscribe_configs
/api/organizations/{organization_id}/pipeline_destinations/repository
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/repository
/api/organizations/{organization_id}/pipeline_destinations/unused
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/unused
/api/organizations/{organization_id}/pipeline_destinations/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/{id}
/api/organizations/{organization_id}/pipeline_destinations/{id}/check_for_updates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/check_for_updates
/api/organizations/{organization_id}/pipeline_destinations/{id}/source
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_destinations/{id}/source
/api/organizations/{organization_id}/pipeline_frontend_apps
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps
/api/organizations/{organization_id}/pipeline_frontend_apps/activity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/activity
/api/organizations/{organization_id}/pipeline_frontend_apps/exports_unsubscribe_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/exports_unsubscribe_configs
/api/organizations/{organization_id}/pipeline_frontend_apps/repository
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/repository
/api/organizations/{organization_id}/pipeline_frontend_apps/unused
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/unused
/api/organizations/{organization_id}/pipeline_frontend_apps/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}
/api/organizations/{organization_id}/pipeline_frontend_apps/{id}/check_for_updates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/check_for_updates
/api/organizations/{organization_id}/pipeline_frontend_apps/{id}/source
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_frontend_apps/{id}/source
/api/organizations/{organization_id}/pipeline_import_apps
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps
/api/organizations/{organization_id}/pipeline_import_apps/activity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/activity
/api/organizations/{organization_id}/pipeline_import_apps/exports_unsubscribe_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/exports_unsubscribe_configs
/api/organizations/{organization_id}/pipeline_import_apps/repository
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/repository
/api/organizations/{organization_id}/pipeline_import_apps/unused
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/unused
/api/organizations/{organization_id}/pipeline_import_apps/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}
/api/organizations/{organization_id}/pipeline_import_apps/{id}/check_for_updates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/check_for_updates
/api/organizations/{organization_id}/pipeline_import_apps/{id}/source
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_import_apps/{id}/source
/api/organizations/{organization_id}/pipeline_transformations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations
/api/organizations/{organization_id}/pipeline_transformations/activity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/activity
/api/organizations/{organization_id}/pipeline_transformations/exports_unsubscribe_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/exports_unsubscribe_configs
/api/organizations/{organization_id}/pipeline_transformations/repository
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/repository
/api/organizations/{organization_id}/pipeline_transformations/unused
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/unused
/api/organizations/{organization_id}/pipeline_transformations/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/{id}
/api/organizations/{organization_id}/pipeline_transformations/{id}/check_for_updates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/check_for_updates
/api/organizations/{organization_id}/pipeline_transformations/{id}/source
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/pipeline_transformations/{id}/source
/api/organizations/{organization_id}/plugins
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins
/api/organizations/{organization_id}/plugins/activity
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/activity
/api/organizations/{organization_id}/plugins/exports_unsubscribe_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/exports_unsubscribe_configs
/api/organizations/{organization_id}/plugins/repository
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/repository
/api/organizations/{organization_id}/plugins/unused
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/unused
/api/organizations/{organization_id}/plugins/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/{id}
/api/organizations/{organization_id}/plugins/{id}/check_for_updates
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/{id}/check_for_updates
/api/organizations/{organization_id}/plugins/{id}/source
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this plugin. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/plugins/{id}/source
/api/organizations/{organization_id}/projects
Projects for the current organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/projects
/api/organizations/{organization_id}/projects/{id}
Projects for the current organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this team. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/projects/{id}
/api/organizations/{organization_id}/projects/{id}/activity
Projects for the current organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this team. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/projects/{id}/activity
/api/organizations/{organization_id}/projects/{id}/is_generating_demo_data
Projects for the current organization.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this team. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/projects/{id}/is_generating_demo_data
/api/organizations/{organization_id}/roles
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/roles
/api/organizations/{organization_id}/roles/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this role. |
| organization_id | path | required | string |
GET /api/organizations/{organization_id}/roles/{id}
/api/organizations/{organization_id}/roles/{role_id}/role_memberships
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| organization_id | path | required | string | |
| role_id | path | required | string |
GET /api/organizations/{organization_id}/roles/{role_id}/role_memberships
/api/projects/{project_id}/persons
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| distinct_id | query | optional | string | Filter list by distinct id. |
| query | optional | string | Filter persons by email (exact match) | |
| format | query | optional | string | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
| properties | query | optional | array | Filter Persons by person properties. |
| search | query | optional | string | Search persons, either by email (full text search) or distinct_id (exact match). |
GET /api/projects/{project_id}/persons
/api/projects/{project_id}/persons/activity
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/activity
/api/projects/{project_id}/persons/cohorts
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/cohorts
/api/projects/{project_id}/persons/funnel
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/funnel
/api/projects/{project_id}/persons/funnel/correlation
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/funnel/correlation
/api/projects/{project_id}/persons/lifecycle
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/lifecycle
/api/projects/{project_id}/persons/path
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/path
/api/projects/{project_id}/persons/retention
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/retention
/api/projects/{project_id}/persons/stickiness
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/stickiness
/api/projects/{project_id}/persons/trends
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/trends
/api/projects/{project_id}/persons/values
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/values
/api/projects/{project_id}/persons/{id}
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/{id}
/api/projects/{project_id}/persons/{id}/activity
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/{id}/activity
/api/projects/{project_id}/persons/{id}/properties_timeline
To create or update persons, use a PostHog library of your choice and [use an identify call](https://app.posthog.com). This API endpoint is only for reading and deleting.
| 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/. |
GET /api/projects/{project_id}/persons/{id}/properties_timeline
/api/projects/{project_id}/pipeline_destination_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/pipeline_destination_configs
/api/projects/{project_id}/pipeline_destination_configs/{id}
| 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/. |
GET /api/projects/{project_id}/pipeline_destination_configs/{id}
/api/projects/{project_id}/pipeline_destination_configs/{id}/frontend
| 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/. |
GET /api/projects/{project_id}/pipeline_destination_configs/{id}/frontend
/api/projects/{project_id}/pipeline_frontend_apps_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/pipeline_frontend_apps_configs
/api/projects/{project_id}/pipeline_frontend_apps_configs/{id}
| 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/. |
GET /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}
/api/projects/{project_id}/pipeline_frontend_apps_configs/{id}/frontend
| 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/. |
GET /api/projects/{project_id}/pipeline_frontend_apps_configs/{id}/frontend
/api/projects/{project_id}/pipeline_import_apps_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/pipeline_import_apps_configs
/api/projects/{project_id}/pipeline_import_apps_configs/{id}
| 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/. |
GET /api/projects/{project_id}/pipeline_import_apps_configs/{id}
/api/projects/{project_id}/pipeline_import_apps_configs/{id}/frontend
| 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/. |
GET /api/projects/{project_id}/pipeline_import_apps_configs/{id}/frontend
/api/projects/{project_id}/pipeline_transformation_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/pipeline_transformation_configs
/api/projects/{project_id}/pipeline_transformation_configs/{id}
| 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/. |
GET /api/projects/{project_id}/pipeline_transformation_configs/{id}
/api/projects/{project_id}/pipeline_transformation_configs/{id}/frontend
| 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/. |
GET /api/projects/{project_id}/pipeline_transformation_configs/{id}/frontend
/api/projects/{project_id}/plugin_configs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/plugin_configs
/api/projects/{project_id}/plugin_configs/{id}
| 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/. |
GET /api/projects/{project_id}/plugin_configs/{id}
/api/projects/{project_id}/plugin_configs/{id}/frontend
| 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/. |
GET /api/projects/{project_id}/plugin_configs/{id}/frontend
/api/projects/{project_id}/plugin_configs/{plugin_config_id}/logs
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| plugin_config_id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/plugin_configs/{plugin_config_id}/logs
/api/projects/{project_id}/property_definitions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| event_names | query | optional | string | If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded |
| excluded_properties | query | optional | string | JSON-encoded list of excluded properties |
| filter_by_event_names | query | optional | boolean | Whether to return only properties for events in `event_names` |
| group_type_index | query | optional | integer | What group type is the property for. Only should be set if `type=group` |
| is_feature_flag | query | optional | boolean | Whether to return only (or excluding) feature flag properties |
| is_numerical | query | optional | boolean | Whether to return only (or excluding) numerical property definitions |
| 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/. |
| properties | query | optional | string | Comma-separated list of properties to filter |
| search | query | optional | string | Searches properties by name |
| type | query | optional | string | What property definitions to return * `event` - event * `person` - person * `group` - group |
GET /api/projects/{project_id}/property_definitions
/api/projects/{project_id}/property_definitions/seen_together
Allows a caller to provide a list of event names and a single property name Returns a map of the event names to a boolean representing whether that property has ever been seen with that event_name
| 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/. |
GET /api/projects/{project_id}/property_definitions/seen_together
/api/projects/{project_id}/property_definitions/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/property_definitions/{id}
/api/projects/{project_id}/query/draft_sql
| 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/. |
GET /api/projects/{project_id}/query/draft_sql
/api/projects/{project_id}/query/{id}
(Experimental)
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/query/{id}
/api/projects/{project_id}/session_recording_playlists
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| created_by | query | optional | integer | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | query | optional | string |
GET /api/projects/{project_id}/session_recording_playlists
/api/projects/{project_id}/session_recording_playlists/{short_id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | path | required | string |
GET /api/projects/{project_id}/session_recording_playlists/{short_id}
/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
| short_id | path | required | string |
GET /api/projects/{project_id}/session_recording_playlists/{short_id}/recordings
/api/projects/{project_id}/session_recordings
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/session_recordings
/api/projects/{project_id}/session_recordings/error_clusters
| 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/. |
GET /api/projects/{project_id}/session_recordings/error_clusters
/api/projects/{project_id}/session_recordings/matching_events
Gets a list of event ids that match the given session recording filter. The filter must include a single session ID. And must include at least one event or action filter. This API is intended for internal use and might have unannounced breaking changes.
| 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/. |
GET /api/projects/{project_id}/session_recordings/matching_events
/api/projects/{project_id}/session_recordings/properties
| 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/. |
GET /api/projects/{project_id}/session_recordings/properties
/api/projects/{project_id}/session_recordings/{id}
| 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/. |
GET /api/projects/{project_id}/session_recordings/{id}
/api/projects/{project_id}/session_recordings/{id}/similar_sessions
| 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/. |
GET /api/projects/{project_id}/session_recordings/{id}/similar_sessions
/api/projects/{project_id}/session_recordings/{id}/snapshots
Snapshots can be loaded from multiple places: 1. From S3 if the session is older than our ingestion limit. This will be multiple files that can be streamed to the client 2. or from Redis if the session is newer than our ingestion limit. Clients need to call this API twice. First without a source parameter to get a list of sources supported by the given session. And then once for each source in the returned list to get the actual snapshots. NB version 1 of this API has been deprecated and ClickHouse stored snapshots are no longer supported.
| 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/. |
GET /api/projects/{project_id}/session_recordings/{id}/snapshots
/api/projects/{project_id}/session_recordings/{recording_id}/sharing
| 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/. |
| recording_id | path | required | string |
GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing
/api/projects/{project_id}/subscriptions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/subscriptions
/api/projects/{project_id}/subscriptions/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | A unique integer value identifying this subscription. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/subscriptions/{id}
/api/projects/{project_id}/surveys
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
| 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/. |
GET /api/projects/{project_id}/surveys
/api/projects/{project_id}/surveys/responses_count
| 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/. |
GET /api/projects/{project_id}/surveys/responses_count
/api/projects/{project_id}/surveys/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | string | A UUID string identifying this survey. |
| project_id | path | required | string | Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. |
GET /api/projects/{project_id}/surveys/{id}
/api/users
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| is_staff | query | optional | boolean | |
| limit | query | optional | integer | Number of results to return per page. |
| offset | query | optional | integer | The initial index from which to return the results. |
GET /api/users
/api/users/{uuid}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| uuid | path | required | string |
GET /api/users/{uuid}
/api/users/{uuid}/start_2fa_setup
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| uuid | path | required | string |
GET /api/users/{uuid}/start_2fa_setup
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
}
}
}
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
}
}
}
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"
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
AggregationAxisFormat
{
"enum": [
"numeric",
"duration",
"duration_ms",
"percentage",
"percentage_scaled"
],
"type": "string",
"title": "AggregationAxisFormat"
}
AggregationAxisFormatNullable
{
"enum": [
"numeric",
"duration",
"duration_ms",
"percentage",
"percentage_scaled"
],
"type": "string",
"title": "AggregationAxisFormat",
"default": null,
"nullable": true
}
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
}
}
}
AnnotationScopeEnum
{
"enum": [
"dashboard_item",
"project",
"organization"
],
"type": "string",
"description": "* `dashboard_item` - insight\n* `project` - project\n* `organization` - organization"
}
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."
}
}
}
BaseMathType
{
"enum": [
"total",
"dau",
"weekly_active",
"monthly_active",
"unique_session"
],
"type": "string",
"title": "BaseMathType"
}
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."
}
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"
}
}
}
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"
}
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"
}
}
}
BatchExportLogEntryLevelEnum
{
"enum": [
"DEBUG",
"LOG",
"INFO",
"WARNING",
"ERROR"
],
"type": "string",
"description": "* `DEBUG` - DEBUG\n* `LOG` - LOG\n* `INFO` - INFO\n* `WARNING` - WARNING\n* `ERROR` - ERROR"
}
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"
}
}
}
BlankEnum
{
"enum": [
""
],
"type": "string"
}
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
}
}
}
BreakdownAttributionType
{
"enum": [
"first_touch",
"last_touch",
"all_events",
"step"
],
"type": "string",
"title": "BreakdownAttributionType"
}
BreakdownAttributionTypeNullable
{
"enum": [
"first_touch",
"last_touch",
"all_events",
"step"
],
"type": "string",
"title": "BreakdownAttributionType",
"default": null,
"nullable": true
}
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
}
}
}
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"
}
BreakdownItem
{
"type": "object",
"title": "BreakdownItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Value"
}
}
}
BreakdownType
{
"enum": [
"cohort",
"person",
"event",
"group",
"session",
"hogql",
"data_warehouse"
],
"type": "string",
"title": "BreakdownType"
}
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"
}
BreakdownTypeNullable
{
"enum": [
"cohort",
"person",
"event",
"group",
"session",
"hogql",
"data_warehouse"
],
"type": "string",
"title": "BreakdownType",
"default": null,
"nullable": true
}
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"
}
ChartAxis
{
"type": "object",
"title": "ChartAxis",
"required": [
"column"
],
"properties": {
"column": {
"type": "string",
"title": "Column"
}
}
}
ChartAxisNullable
{
"type": "object",
"title": "ChartAxis",
"default": null,
"nullable": true,
"required": [
"column"
],
"properties": {
"column": {
"type": "string",
"title": "Column"
}
}
}
ChartDisplayType
{
"enum": [
"ActionsLineGraph",
"ActionsBar",
"ActionsAreaGraph",
"ActionsLineGraphCumulative",
"BoldNumber",
"ActionsPie",
"ActionsBarValue",
"ActionsTable",
"WorldMap"
],
"type": "string",
"title": "ChartDisplayType"
}
ChartDisplayTypeNullable
{
"enum": [
"ActionsLineGraph",
"ActionsBar",
"ActionsAreaGraph",
"ActionsLineGraphCumulative",
"BoldNumber",
"ActionsPie",
"ActionsBarValue",
"ActionsTable",
"WorldMap"
],
"type": "string",
"title": "ChartDisplayType",
"default": null,
"nullable": true
}
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
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
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"
}
}
}
Compare
{
"enum": [
"current",
"previous"
],
"type": "string",
"title": "Compare"
}
CompareItem
{
"type": "object",
"title": "CompareItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "string",
"title": "Value"
}
}
}
CompareNullable
{
"enum": [
"current",
"previous"
],
"type": "string",
"title": "Compare",
"default": null,
"nullable": true
}
CorrelationType
{
"enum": [
"success",
"failure"
],
"type": "string",
"title": "CorrelationType"
}
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"
}
CreationModeEnum
{
"enum": [
"default",
"template",
"duplicate"
],
"type": "string",
"description": "* `default` - Default\n* `template` - Template\n* `duplicate` - Duplicate"
}
CreationTypeEnum
{
"enum": [
"USR",
"GIT"
],
"type": "string",
"description": "* `USR` - user\n* `GIT` - GitHub"
}
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
}
}
}
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
}
}
}
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
}
}
}
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
}
}
}
DashboardTemplateScopeEnum
{
"enum": [
"team",
"global",
"feature_flag"
],
"type": "string",
"description": "* `team` - Only team\n* `global` - Global\n* `feature_flag` - Feature Flag"
}
DashboardTileBasic
{
"type": "object",
"required": [
"dashboard_id",
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"deleted": {
"type": "boolean",
"nullable": true
},
"dashboard_id": {
"type": "integer",
"readOnly": true
}
}
}
DashboardsListCollaboratorsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
DashboardsSharingListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
DataTableNode
{
"type": "object",
"title": "DataTableNode",
"required": [
"source"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in scenes."
},
"kind": {
"const": "DataTableNode",
"title": "Kind",
"default": "DataTableNode"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/EventsQuery"
},
{
"$ref": "#/components/schemas/PersonsNode"
},
{
"$ref": "#/components/schemas/ActorsQuery"
},
{
"$ref": "#/components/schemas/HogQLQuery"
},
{
"$ref": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
{
"$ref": "#/components/schemas/WebOverviewQuery"
},
{
"$ref": "#/components/schemas/WebStatsTableQuery"
},
{
"$ref": "#/components/schemas/WebTopClicksQuery"
}
],
"title": "Source",
"description": "Source of the events"
},
"columns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Columns shown in the table, unless the `source` provides them."
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Uses the embedded version of LemonTable"
},
"expandable": {
"type": "boolean",
"title": "Expandable",
"default": null,
"nullable": true,
"description": "Can expand row to show raw event data (default: true)"
},
"showExport": {
"type": "boolean",
"title": "Showexport",
"default": null,
"nullable": true,
"description": "Show the export button"
},
"showReload": {
"type": "boolean",
"title": "Showreload",
"default": null,
"nullable": true,
"description": "Show a reload button"
},
"showSearch": {
"type": "boolean",
"title": "Showsearch",
"default": null,
"nullable": true,
"description": "Include a free text search field (PersonsNode only)"
},
"showActions": {
"type": "boolean",
"title": "Showactions",
"default": null,
"nullable": true,
"description": "Show the kebab menu at the end of the row"
},
"showTimings": {
"type": "boolean",
"title": "Showtimings",
"default": null,
"nullable": true,
"description": "Show a detailed query timing breakdown"
},
"allowSorting": {
"type": "boolean",
"title": "Allowsorting",
"default": null,
"nullable": true,
"description": "Can the user click on column headers to sort the table? (default: true)"
},
"hiddenColumns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hiddencolumns",
"default": null,
"nullable": true,
"description": "Columns that aren't shown in the table, even if in columns or returned data"
},
"showDateRange": {
"type": "boolean",
"title": "Showdaterange",
"default": null,
"nullable": true,
"description": "Show date range selector"
},
"showElapsedTime": {
"type": "boolean",
"title": "Showelapsedtime",
"default": null,
"nullable": true,
"description": "Show the time it takes to run a query"
},
"showEventFilter": {
"type": "boolean",
"title": "Showeventfilter",
"default": null,
"nullable": true,
"description": "Include an event filter above the table (EventsNode only)"
},
"showHogQLEditor": {
"type": "boolean",
"title": "Showhogqleditor",
"default": null,
"nullable": true,
"description": "Include a HogQL query editor above HogQL tables"
},
"propertiesViaUrl": {
"type": "boolean",
"title": "Propertiesviaurl",
"default": null,
"nullable": true,
"description": "Link properties via the URL (default: false)"
},
"showResultsTable": {
"type": "boolean",
"title": "Showresultstable",
"default": null,
"nullable": true,
"description": "Show a results table"
},
"showSavedQueries": {
"type": "boolean",
"title": "Showsavedqueries",
"default": null,
"nullable": true,
"description": "Shows a list of saved queries"
},
"showPropertyFilter": {
"type": "boolean",
"title": "Showpropertyfilter",
"default": null,
"nullable": true,
"description": "Include a property filter above the table"
},
"showOpenEditorButton": {
"type": "boolean",
"title": "Showopeneditorbutton",
"default": null,
"nullable": true,
"description": "Show a button to open the current query as a new insight. (default: true)"
},
"showColumnConfigurator": {
"type": "boolean",
"title": "Showcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure the table's columns if possible"
},
"showTestAccountFilters": {
"type": "boolean",
"title": "Showtestaccountfilters",
"default": null,
"nullable": true,
"description": "Show filter to exclude test accounts"
},
"showPersistentColumnConfigurator": {
"type": "boolean",
"title": "Showpersistentcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure and persist the table's default columns if possible"
}
}
}
DataVisualizationNode
{
"type": "object",
"title": "DataVisualizationNode",
"required": [
"source"
],
"properties": {
"kind": {
"const": "DataVisualizationNode",
"title": "Kind",
"default": "DataVisualizationNode"
},
"source": {
"$ref": "#/components/schemas/HogQLQuery"
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"chartSettings": {
"$ref": "#/components/schemas/ChartSettingsNullable"
}
}
}
DataWarehouseEventsModifier
{
"type": "object",
"title": "DataWarehouseEventsModifier",
"required": [
"distinct_id_field",
"id_field",
"table_name",
"timestamp_field"
],
"properties": {
"id_field": {
"type": "string",
"title": "Id Field"
},
"table_name": {
"type": "string",
"title": "Table Name"
},
"timestamp_field": {
"type": "string",
"title": "Timestamp Field"
},
"distinct_id_field": {
"type": "string",
"title": "Distinct Id Field"
}
}
}
DataWarehouseNode
{
"type": "object",
"title": "DataWarehouseNode",
"required": [
"distinct_id_field",
"id",
"id_field",
"table_name",
"timestamp_field"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"kind": {
"const": "DataWarehouseNode",
"title": "Kind",
"default": "DataWarehouseNode"
},
"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
},
"id_field": {
"type": "string",
"title": "Id Field"
},
"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"
},
"table_name": {
"type": "string",
"title": "Table Name"
},
"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)"
},
"timestamp_field": {
"type": "string",
"title": "Timestamp Field"
},
"distinct_id_field": {
"type": "string",
"title": "Distinct Id Field"
},
"math_group_type_index": {
"$ref": "#/components/schemas/MathGroupTypeIndexNullable"
}
}
}
DataWarehousePersonPropertyFilter
{
"type": "object",
"title": "DataWarehousePersonPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "data_warehouse_person_property",
"title": "Type",
"default": "data_warehouse_person_property"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
DataWarehousePropertyFilter
{
"type": "object",
"title": "DataWarehousePropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "data_warehouse",
"title": "Type",
"default": "data_warehouse"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
DatabaseSchemaQuery
{
"type": "object",
"title": "DatabaseSchemaQuery",
"properties": {
"kind": {
"const": "DatabaseSchemaQuery",
"title": "Kind",
"default": "DatabaseSchemaQuery"
},
"response": {
"type": "object",
"title": "Response",
"default": null,
"nullable": true,
"description": "Cached query response",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSchemaQueryResponseField"
}
}
}
}
}
DatabaseSchemaQueryResponseField
{
"type": "object",
"title": "DatabaseSchemaQueryResponseField",
"required": [
"key",
"type"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"type": "string",
"title": "Type"
},
"chain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Chain",
"default": null,
"nullable": true
},
"table": {
"type": "string",
"title": "Table",
"default": null,
"nullable": true
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"title": "Fields",
"default": null,
"nullable": true
}
}
}
DateRange
{
"type": "object",
"title": "DateRange",
"properties": {
"date_to": {
"type": "string",
"title": "Date To",
"default": null,
"nullable": true
},
"date_from": {
"type": "string",
"title": "Date From",
"default": null,
"nullable": true
},
"explicitDate": {
"type": "boolean",
"title": "Explicitdate",
"default": null,
"nullable": true,
"description": "Whether the date_from and date_to should be used verbatim. Disables rounding to the start and end of period."
}
}
}
DateRangeNullable
{
"type": "object",
"title": "DateRange",
"default": null,
"nullable": true,
"properties": {
"date_to": {
"type": "string",
"title": "Date To",
"default": null,
"nullable": true
},
"date_from": {
"type": "string",
"title": "Date From",
"default": null,
"nullable": true
},
"explicitDate": {
"type": "boolean",
"title": "Explicitdate",
"default": null,
"nullable": true,
"description": "Whether the date_from and date_to should be used verbatim. Disables rounding to the start and end of period."
}
}
}
DayItem
{
"type": "object",
"title": "DayItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "integer"
}
],
"title": "Value"
}
}
}
DisplayEnum
{
"enum": [
"ActionsLineGraph",
"ActionsLineGraphCumulative",
"ActionsTable",
"ActionsPie",
"ActionsBar",
"ActionsBarValue",
"WorldMap",
"BoldNumber"
],
"type": "string",
"description": "* `ActionsLineGraph` - ActionsLineGraph\n* `ActionsLineGraphCumulative` - ActionsLineGraphCumulative\n* `ActionsTable` - ActionsTable\n* `ActionsPie` - ActionsPie\n* `ActionsBar` - ActionsBar\n* `ActionsBarValue` - ActionsBarValue\n* `WorldMap` - WorldMap\n* `BoldNumber` - BoldNumber"
}
EarlyAccessFeature
{
"type": "object",
"required": [
"created_at",
"feature_flag",
"id",
"name",
"stage"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
EarlyAccessFeatureSerializerCreateOnly
{
"type": "object",
"required": [
"created_at",
"feature_flag",
"id",
"name",
"stage"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_id": {
"type": "integer",
"writeOnly": true
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
EffectiveMembershipLevelEnum
{
"enum": [
1,
8,
15
],
"type": "integer"
}
EffectivePrivilegeLevelEnum
{
"enum": [
21,
37
],
"type": "integer"
}
EffectiveRestrictionLevelEnum
{
"enum": [
21,
37
],
"type": "integer"
}
ElementPropertyFilter
{
"type": "object",
"title": "ElementPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"$ref": "#/components/schemas/Key"
},
"type": {
"const": "element",
"title": "Type",
"default": "element"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
ElementType
{
"type": "object",
"title": "ElementType",
"required": [
"attributes",
"tag_name"
],
"properties": {
"href": {
"type": "string",
"title": "Href",
"default": null,
"nullable": true
},
"text": {
"type": "string",
"title": "Text",
"default": null,
"nullable": true
},
"order": {
"type": "number",
"title": "Order",
"default": null,
"nullable": true
},
"attr_id": {
"type": "string",
"title": "Attr Id",
"default": null,
"nullable": true
},
"tag_name": {
"type": "string",
"title": "Tag Name"
},
"nth_child": {
"type": "number",
"title": "Nth Child",
"default": null,
"nullable": true
},
"attr_class": {
"type": "array",
"items": {
"type": "string"
},
"title": "Attr Class",
"default": null,
"nullable": true
},
"attributes": {
"type": "object",
"title": "Attributes",
"additionalProperties": {
"type": "string"
}
},
"nth_of_type": {
"type": "number",
"title": "Nth Of Type",
"default": null,
"nullable": true
}
}
}
EmptyPropertyFilter
{
"type": "object",
"title": "EmptyPropertyFilter",
"properties": {}
}
EntityType
{
"enum": [
"actions",
"events",
"data_warehouse",
"new_entity"
],
"type": "string",
"title": "EntityType"
}
EntityTypeNullable
{
"enum": [
"actions",
"events",
"data_warehouse",
"new_entity"
],
"type": "string",
"title": "EntityType",
"default": null,
"nullable": true
}
EventDefinition
{
"type": "object",
"title": "EventDefinition",
"required": [
"elements",
"event",
"properties"
],
"properties": {
"event": {
"type": "string",
"title": "Event"
},
"elements": {
"type": "array",
"items": {},
"title": "Elements"
},
"properties": {
"type": "object",
"title": "Properties"
}
}
}
EventOddsRatioSerialized
{
"type": "object",
"title": "EventOddsRatioSerialized",
"required": [
"correlation_type",
"event",
"failure_count",
"odds_ratio",
"success_count"
],
"properties": {
"event": {
"$ref": "#/components/schemas/EventDefinition"
},
"odds_ratio": {
"type": "number",
"title": "Odds Ratio"
},
"failure_count": {
"type": "integer",
"title": "Failure Count"
},
"success_count": {
"type": "integer",
"title": "Success Count"
},
"correlation_type": {
"$ref": "#/components/schemas/CorrelationType"
}
}
}
EventPropertyFilter
{
"type": "object",
"title": "EventPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "event",
"title": "Type",
"default": "event",
"description": "Event properties"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
EventType
{
"type": "object",
"title": "EventType",
"required": [
"distinct_id",
"elements",
"event",
"id",
"properties",
"timestamp"
],
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"event": {
"type": "string",
"title": "Event"
},
"person": {
"$ref": "#/components/schemas/PersonNullable"
},
"elements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ElementType"
},
"title": "Elements"
},
"timestamp": {
"type": "string",
"title": "Timestamp"
},
"properties": {
"type": "object",
"title": "Properties"
},
"distinct_id": {
"type": "string",
"title": "Distinct Id"
},
"elements_chain": {
"type": "string",
"title": "Elements Chain",
"default": null,
"nullable": true
}
}
}
EventsNode
{
"type": "object",
"title": "EventsNode",
"properties": {
"kind": {
"const": "EventsNode",
"title": "Kind",
"default": "EventsNode"
},
"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
},
"event": {
"type": "string",
"title": "Event",
"default": null,
"nullable": true,
"description": "The event or `null` for all events."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"title": "Orderby",
"default": null,
"nullable": true,
"description": "Columns to order by"
},
"response": {
"$ref": "#/components/schemas/ResponseNullable"
},
"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"
}
}
}
EventsQuery
{
"type": "object",
"title": "EventsQuery",
"required": [
"select"
],
"properties": {
"kind": {
"const": "EventsQuery",
"title": "Kind",
"default": "EventsQuery"
},
"after": {
"type": "string",
"title": "After",
"default": null,
"nullable": true,
"description": "Only fetch events that happened after this timestamp"
},
"event": {
"type": "string",
"title": "Event",
"default": null,
"nullable": true,
"description": "Limit to events matching this string"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true,
"description": "Number of rows to return"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"title": "Where",
"default": null,
"nullable": true,
"description": "HogQL filters to apply on returned data"
},
"before": {
"type": "string",
"title": "Before",
"default": null,
"nullable": true,
"description": "Only fetch events that happened before this timestamp"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true,
"description": "Number of rows to skip before returning rows"
},
"select": {
"type": "array",
"items": {
"type": "string"
},
"title": "Select",
"description": "Return a limited set of data. Required."
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"title": "Orderby",
"default": null,
"nullable": true,
"description": "Columns to order by"
},
"actionId": {
"type": "integer",
"title": "Actionid",
"default": null,
"nullable": true,
"description": "Show events matching a given action"
},
"personId": {
"type": "string",
"title": "Personid",
"default": null,
"nullable": true,
"description": "Show events for a given person"
},
"response": {
"$ref": "#/components/schemas/EventsQueryResponseNullable"
},
"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"
},
"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)"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Filter test accounts"
}
}
}
EventsQueryResponse
{
"type": "object",
"title": "EventsQueryResponse",
"required": [
"columns",
"hogql",
"results",
"types"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"title": "Types"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"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
}
}
}
EventsQueryResponseNullable
{
"type": "object",
"title": "EventsQueryResponse",
"default": null,
"nullable": true,
"required": [
"columns",
"hogql",
"results",
"types"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"title": "Types"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"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
}
},
"description": "Cached query response"
}
Experiment
{
"type": "object",
"required": [
"created_at",
"created_by",
"feature_flag",
"feature_flag_key",
"id",
"name",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"filters": {},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"parameters": {
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_key": {
"type": "string"
},
"secondary_metrics": {
"nullable": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
ExplicitTeamMember
{
"type": "object",
"required": [
"effective_level",
"id",
"joined_at",
"parent_level",
"parent_membership_id",
"updated_at",
"user",
"user_uuid"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/ExplicitTeamMemberLevelEnum"
},
"joined_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
},
"parent_level": {
"type": "integer",
"readOnly": true
},
"effective_level": {
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
},
"parent_membership_id": {
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
},
"effective_level": {
"readOnly": true,
"description": "If organization level is higher than project level, then that takes precedence over explicit project level."
}
}
}
ExplicitTeamMemberLevelEnum
{
"enum": [
1,
8
],
"type": "integer",
"description": "* `1` - member\n* `8` - administrator"
}
ExplicitmembersGetMembersResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
ExportFormatEnum
{
"enum": [
"image/png",
"application/pdf",
"text/csv",
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
],
"type": "string",
"description": "* `image/png` - image/png\n* `application/pdf` - application/pdf\n* `text/csv` - text/csv\n* `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}
ExportedAsset
{
"type": "object",
"required": [
"created_at",
"export_format",
"filename",
"has_content",
"id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"insight": {
"type": "integer",
"nullable": true
},
"filename": {
"type": "string",
"readOnly": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"has_content": {
"type": "string",
"readOnly": true
},
"expires_after": {
"type": "string",
"format": "date-time",
"nullable": true
},
"export_format": {
"$ref": "#/components/schemas/ExportFormatEnum"
},
"export_context": {
"nullable": true
}
},
"description": "Standard ExportedAsset serializer that doesn't return content."
}
FeatureFlag
{
"type": "object",
"required": [
"can_edit",
"created_by",
"experiment_set",
"features",
"id",
"is_simple_flag",
"key",
"rollout_percentage",
"surveys",
"usage_dashboard"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string",
"description": "contains the description for the flag (field name `name` is kept for backwards-compatibility)"
},
"tags": {
"type": "array",
"items": {}
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"surveys": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"can_edit": {
"type": "boolean",
"readOnly": true
},
"features": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"experiment_set": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
},
"is_simple_flag": {
"type": "boolean",
"readOnly": true
},
"usage_dashboard": {
"type": "integer",
"readOnly": true
},
"performed_rollback": {
"type": "boolean",
"nullable": true
},
"rollout_percentage": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"rollback_conditions": {
"nullable": true
},
"analytics_dashboards": {
"type": "array",
"items": {
"type": "integer"
}
},
"has_enriched_analytics": {
"type": "boolean",
"nullable": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
FeatureFlagRoleAccess
{
"type": "object",
"required": [
"added_at",
"feature_flag",
"id",
"role",
"role_id",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"role": {
"$ref": "#/components/schemas/Role"
},
"role_id": {
"type": "string",
"format": "uuid",
"writeOnly": true
},
"added_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"feature_flag": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"x-konfig-properties": {
"role": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
FeatureFlagsAccessLevelEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Can only view\n* `37` - Can always edit"
}
FeaturePropertyFilter
{
"type": "object",
"title": "FeaturePropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "feature",
"title": "Type",
"default": "feature",
"description": "Event property with \"$feature/\" prepended"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
FilterAction
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the action to filter on. For example `2841`."
},
"math": {
"$ref": "#/components/schemas/MathEnum"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
}
},
"x-konfig-properties": {
"math": {
"default": "total",
"description": "How to aggregate results, shown as \"counted by\" in the interface.\n- `total` (default): no aggregation, count by events\n- `dau`: count by unique users. Despite the name, if you select the `interval` to be weekly or monthly, this will show weekly or monthly active users respectively\n- `weekly_active`: rolling average of users of the last 7 days.\n- `monthly_active`: rolling average of users of the last month.\n- `unique_group`: count by group. Requires `math_group_type_index` to be sent. You can get the index by hitting `/api/projects/@current/groups_types/`.\n\nAll of the below are property aggregations, and require `math_property` to be sent with an event property.\n- `sum`: sum of a numeric property.\n- `min`: min of a numeric property.\n- `max`: max of a numeric property.\n- `median`: median of a numeric property.\n- `p90`: 90th percentile of a numeric property.\n- `p95` 95th percentile of a numeric property.\n- `p99`: 99th percentile of a numeric property.\n\n\n* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
}
}
FilterEvent
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Name of the event to filter on. For example `$pageview` or `user sign up`."
},
"math": {
"$ref": "#/components/schemas/MathEnum"
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
}
},
"x-konfig-properties": {
"math": {
"default": "total",
"description": "How to aggregate results, shown as \"counted by\" in the interface.\n- `total` (default): no aggregation, count by events\n- `dau`: count by unique users. Despite the name, if you select the `interval` to be weekly or monthly, this will show weekly or monthly active users respectively\n- `weekly_active`: rolling average of users of the last 7 days.\n- `monthly_active`: rolling average of users of the last month.\n- `unique_group`: count by group. Requires `math_group_type_index` to be sent. You can get the index by hitting `/api/projects/@current/groups_types/`.\n\nAll of the below are property aggregations, and require `math_property` to be sent with an event property.\n- `sum`: sum of a numeric property.\n- `min`: min of a numeric property.\n- `max`: max of a numeric property.\n- `median`: median of a numeric property.\n- `p90`: 90th percentile of a numeric property.\n- `p95` 95th percentile of a numeric property.\n- `p99`: 99th percentile of a numeric property.\n\n\n* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
}
}
FilterLogicalOperator
{
"enum": [
"AND",
"OR"
],
"type": "string",
"title": "FilterLogicalOperator"
}
FrequencyEnum
{
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
],
"type": "string",
"description": "* `daily` - Daily\n* `weekly` - Weekly\n* `monthly` - Monthly\n* `yearly` - Yearly"
}
Funnel
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterEvent"
},
"description": "Events to filter on. One of `events` or `actions` is required."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAction"
},
"description": "Actions to filter on. One of `events` or `actions` is required."
},
"date_to": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"breakdown": {
"type": "string",
"description": "A property or cohort to break down on. You can select the type of the property with breakdown_type.\n- `event` (default): a property key\n- `person`: a person property key\n- `cohort`: an array of cohort IDs (ie `[9581,5812]`)"
},
"date_from": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"exclusions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunnelExclusion"
},
"description": "Exclude users/groups that completed the specified event between two specific steps. Note that these users/groups will be completely excluded from the entire funnel."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"breakdown_type": {
"$ref": "#/components/schemas/BreakdownTypeEnum"
},
"breakdown_limit": {
"type": "integer",
"default": 10
},
"funnel_viz_type": {
"$ref": "#/components/schemas/FunnelVizTypeEnum"
},
"funnel_order_type": {
"$ref": "#/components/schemas/FunnelOrderTypeEnum"
},
"funnel_window_days": {
"type": "integer",
"default": 14,
"description": "(DEPRECATED) Funnel window size in days. Use `funnel_window_interval` and `funnel_window_interval_type`"
},
"filter_test_accounts": {
"type": "boolean",
"default": false,
"description": "Whether to filter out internal and test accounts. See \"project settings\" in your PostHog account for the filters."
},
"funnel_window_interval": {
"type": "integer",
"default": 14,
"description": "Funnel window size. Set in combination with funnel_window_interval, so defaults to 'days'."
},
"funnel_window_interval_type": {
"$ref": "#/components/schemas/FunnelWindowIntervalTypeEnum"
},
"aggregation_group_type_index": {
"type": "integer",
"default": 0,
"description": "Aggregate by users or by groups. `0` means user, `>0` means a group. See interface for the corresponding ID of the group."
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
},
"breakdown_type": {
"default": "event",
"description": "Type of property to break down on.\n\n* `event` - event\n* `person` - person\n* `cohort` - cohort\n* `group` - group\n* `session` - session\n* `hogql` - hogql"
},
"funnel_viz_type": {
"default": "steps",
"description": "The visualisation type.\n- `steps` Track instances progress between steps of the funnel\n- `trends` Track how this funnel's conversion rate is trending over time.\n- `time_to_convert` Track how long it takes for instances to convert\n\n* `trends` - trends\n* `time_to_convert` - time_to_convert\n* `steps` - steps"
},
"funnel_order_type": {
"default": "ordered",
"description": "- `ordered` - Step B must happen after Step A, but any number events can happen between A and B.\n- `strict` - Step B must happen directly after Step A without any events in between.\n- `unordered` - Steps can be completed in any sequence.\n\n* `strict` - strict\n* `unordered` - unordered\n* `ordered` - ordered"
},
"funnel_window_interval_type": {
"default": "days",
"description": "The type of interval. Used in combination with `funnel_window_intervals`.\n\n* `DAY` - DAY\n* `SECOND` - SECOND\n* `MINUTE` - MINUTE\n* `HOUR` - HOUR\n* `WEEK` - WEEK\n* `MONTH` - MONTH"
}
}
}
FunnelConversionWindowTimeUnit
{
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "FunnelConversionWindowTimeUnit"
}
FunnelConversionWindowTimeUnitNullable
{
"enum": [
"second",
"minute",
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "FunnelConversionWindowTimeUnit",
"default": null,
"nullable": true
}
FunnelCorrelationActorsQuery
{
"type": "object",
"title": "FunnelCorrelationActorsQuery",
"required": [
"source"
],
"properties": {
"kind": {
"const": "FunnelCorrelationActorsQuery",
"title": "Kind",
"default": "FunnelCorrelationActorsQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelCorrelationQuery"
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
},
"funnelCorrelationPersonEntity": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
],
"title": "Funnelcorrelationpersonentity",
"default": null,
"nullable": true
},
"funnelCorrelationPropertyValues": {
"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": "Funnelcorrelationpropertyvalues",
"default": null,
"nullable": true
},
"funnelCorrelationPersonConverted": {
"type": "boolean",
"title": "Funnelcorrelationpersonconverted",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationQuery
{
"type": "object",
"title": "FunnelCorrelationQuery",
"required": [
"funnelCorrelationType",
"source"
],
"properties": {
"kind": {
"const": "FunnelCorrelationQuery",
"title": "Kind",
"default": "FunnelCorrelationQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelsActorsQuery"
},
"response": {
"$ref": "#/components/schemas/FunnelCorrelationResponseNullable"
},
"funnelCorrelationType": {
"$ref": "#/components/schemas/FunnelCorrelationResultsType"
},
"funnelCorrelationNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationnames",
"default": null,
"nullable": true
},
"funnelCorrelationEventNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationeventnames",
"default": null,
"nullable": true
},
"funnelCorrelationExcludeNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationexcludenames",
"default": null,
"nullable": true
},
"funnelCorrelationExcludeEventNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationexcludeeventnames",
"default": null,
"nullable": true
},
"funnelCorrelationEventExcludePropertyNames": {
"type": "array",
"items": {
"type": "string"
},
"title": "Funnelcorrelationeventexcludepropertynames",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResponse
{
"type": "object",
"title": "FunnelCorrelationResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"$ref": "#/components/schemas/FunnelCorrelationResult"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResponseNullable
{
"type": "object",
"title": "FunnelCorrelationResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"$ref": "#/components/schemas/FunnelCorrelationResult"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
FunnelCorrelationResult
{
"type": "object",
"title": "FunnelCorrelationResult",
"required": [
"events",
"skewed"
],
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOddsRatioSerialized"
},
"title": "Events"
},
"skewed": {
"type": "boolean",
"title": "Skewed"
}
}
}
FunnelCorrelationResultsType
{
"enum": [
"events",
"properties",
"event_with_properties"
],
"type": "string",
"title": "FunnelCorrelationResultsType"
}
FunnelExclusion
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Name of the event to filter on. For example `$pageview` or `user sign up`."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"funnel_to_step": {
"type": "integer",
"default": 1
},
"funnel_from_step": {
"type": "integer",
"default": 0
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
}
}
}
FunnelExclusionActionsNode
{
"type": "object",
"title": "FunnelExclusionActionsNode",
"required": [
"funnelFromStep",
"funnelToStep",
"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
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep"
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep"
},
"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"
}
}
}
FunnelExclusionEventsNode
{
"type": "object",
"title": "FunnelExclusionEventsNode",
"required": [
"funnelFromStep",
"funnelToStep"
],
"properties": {
"kind": {
"const": "EventsNode",
"title": "Kind",
"default": "EventsNode"
},
"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
},
"event": {
"type": "string",
"title": "Event",
"default": null,
"nullable": true,
"description": "The event or `null` for all events."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"orderBy": {
"type": "array",
"items": {
"type": "string"
},
"title": "Orderby",
"default": null,
"nullable": true,
"description": "Columns to order by"
},
"response": {
"$ref": "#/components/schemas/ResponseNullable"
},
"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
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep"
},
"math_property": {
"type": "string",
"title": "Math Property",
"default": null,
"nullable": true
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep"
},
"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"
}
}
}
FunnelLayout
{
"enum": [
"horizontal",
"vertical"
],
"type": "string",
"title": "FunnelLayout"
}
FunnelLayoutNullable
{
"enum": [
"horizontal",
"vertical"
],
"type": "string",
"title": "FunnelLayout",
"default": null,
"nullable": true
}
FunnelOrderTypeEnum
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"description": "* `strict` - strict\n* `unordered` - unordered\n* `ordered` - ordered"
}
FunnelPathType
{
"enum": [
"funnel_path_before_step",
"funnel_path_between_steps",
"funnel_path_after_step"
],
"type": "string",
"title": "FunnelPathType"
}
FunnelPathTypeNullable
{
"enum": [
"funnel_path_before_step",
"funnel_path_between_steps",
"funnel_path_after_step"
],
"type": "string",
"title": "FunnelPathType",
"default": null,
"nullable": true
}
FunnelPathsFilter
{
"type": "object",
"title": "FunnelPathsFilter",
"required": [
"funnelSource"
],
"properties": {
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true
},
"funnelSource": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"funnelPathType": {
"$ref": "#/components/schemas/FunnelPathTypeNullable"
}
}
}
FunnelPathsFilterNullable
{
"type": "object",
"title": "FunnelPathsFilter",
"default": null,
"nullable": true,
"required": [
"funnelSource"
],
"properties": {
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true
},
"funnelSource": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"funnelPathType": {
"$ref": "#/components/schemas/FunnelPathTypeNullable"
}
},
"description": "Used for displaying paths in relation to funnel steps."
}
FunnelStepReference
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "FunnelStepReference"
}
FunnelStepReferenceNullable
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "FunnelStepReference",
"default": null,
"nullable": true
}
FunnelStepsResult
{
"type": "object",
"required": [
"action_id",
"average_conversion_time",
"converted_people_url",
"count",
"dropped_people_url",
"median_conversion_time",
"order"
],
"properties": {
"count": {
"type": "integer",
"description": "Number of people in this step."
},
"order": {
"type": "string",
"description": "Order of this step in the funnel. The API should return the steps in order anyway."
},
"action_id": {
"type": "string",
"description": "Corresponds to the `id` of the entities passed through to `events` or `actions`."
},
"dropped_people_url": {
"type": "string",
"description": "Path of a URL to get a list of people that dropped after this step. In this format: `/api/person/funnel?...`"
},
"converted_people_url": {
"type": "string",
"description": "Path of a URL to get a list of people that converted after this step. In this format: `/api/person/funnel?...`"
},
"median_conversion_time": {
"type": "number",
"format": "double",
"description": "Median conversion time of person or groups between steps. `null` for the first step."
},
"average_conversion_time": {
"type": "number",
"format": "double",
"description": "Average conversion time of person or groups between steps. `null` for the first step."
}
}
}
FunnelStepsResults
{
"type": "object",
"required": [
"is_cached",
"last_refresh",
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunnelStepsResult"
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"is_cached": {
"type": "boolean",
"description": "Whether the result is cached. To force a refresh, pass ?refresh=true"
},
"last_refresh": {
"type": "string",
"format": "date-time",
"description": "If the result is cached, when it was last refreshed."
}
},
"x-konfig-properties": {
"timezone": {
"default": "UTC",
"description": "Timezone the chart is displayed in\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Brazil/Acre` - Brazil/Acre\n* `Brazil/DeNoronha` - Brazil/DeNoronha\n* `Brazil/East` - Brazil/East\n* `Brazil/West` - Brazil/West\n* `CET` - CET\n* `CST6CDT` - CST6CDT\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Chile/Continental` - Chile/Continental\n* `Chile/EasterIsland` - Chile/EasterIsland\n* `Cuba` - Cuba\n* `EET` - EET\n* `EST` - EST\n* `EST5EDT` - EST5EDT\n* `Egypt` - Egypt\n* `Eire` - Eire\n* `Etc/GMT` - Etc/GMT\n* `Etc/GMT+0` - Etc/GMT+0\n* `Etc/GMT+1` - Etc/GMT+1\n* `Etc/GMT+10` - Etc/GMT+10\n* `Etc/GMT+11` - Etc/GMT+11\n* `Etc/GMT+12` - Etc/GMT+12\n* `Etc/GMT+2` - Etc/GMT+2\n* `Etc/GMT+3` - Etc/GMT+3\n* `Etc/GMT+4` - Etc/GMT+4\n* `Etc/GMT+5` - Etc/GMT+5\n* `Etc/GMT+6` - Etc/GMT+6\n* `Etc/GMT+7` - Etc/GMT+7\n* `Etc/GMT+8` - Etc/GMT+8\n* `Etc/GMT+9` - Etc/GMT+9\n* `Etc/GMT-0` - Etc/GMT-0\n* `Etc/GMT-1` - Etc/GMT-1\n* `Etc/GMT-10` - Etc/GMT-10\n* `Etc/GMT-11` - Etc/GMT-11\n* `Etc/GMT-12` - Etc/GMT-12\n* `Etc/GMT-13` - Etc/GMT-13\n* `Etc/GMT-14` - Etc/GMT-14\n* `Etc/GMT-2` - Etc/GMT-2\n* `Etc/GMT-3` - Etc/GMT-3\n* `Etc/GMT-4` - Etc/GMT-4\n* `Etc/GMT-5` - Etc/GMT-5\n* `Etc/GMT-6` - Etc/GMT-6\n* `Etc/GMT-7` - Etc/GMT-7\n* `Etc/GMT-8` - Etc/GMT-8\n* `Etc/GMT-9` - Etc/GMT-9\n* `Etc/GMT0` - Etc/GMT0\n* `Etc/Greenwich` - Etc/Greenwich\n* `Etc/UCT` - Etc/UCT\n* `Etc/UTC` - Etc/UTC\n* `Etc/Universal` - Etc/Universal\n* `Etc/Zulu` - Etc/Zulu\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GB` - GB\n* `GB-Eire` - GB-Eire\n* `GMT` - GMT\n* `GMT+0` - GMT+0\n* `GMT-0` - GMT-0\n* `GMT0` - GMT0\n* `Greenwich` - Greenwich\n* `HST` - HST\n* `Hongkong` - Hongkong\n* `Iceland` - Iceland\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Iran` - Iran\n* `Israel` - Israel\n* `Jamaica` - Jamaica\n* `Japan` - Japan\n* `Kwajalein` - Kwajalein\n* `Libya` - Libya\n* `MET` - MET\n* `MST` - MST\n* `MST7MDT` - MST7MDT\n* `Mexico/BajaNorte` - Mexico/BajaNorte\n* `Mexico/BajaSur` - Mexico/BajaSur\n* `Mexico/General` - Mexico/General\n* `NZ` - NZ\n* `NZ-CHAT` - NZ-CHAT\n* `Navajo` - Navajo\n* `PRC` - PRC\n* `PST8PDT` - PST8PDT\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `Poland` - Poland\n* `Portugal` - Portugal\n* `ROC` - ROC\n* `ROK` - ROK\n* `Singapore` - Singapore\n* `Turkey` - Turkey\n* `UCT` - UCT\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC\n* `Universal` - Universal\n* `W-SU` - W-SU\n* `WET` - WET\n* `Zulu` - Zulu"
}
}
}
FunnelVizType
{
"enum": [
"steps",
"time_to_convert",
"trends"
],
"type": "string",
"title": "FunnelVizType"
}
FunnelVizTypeEnum
{
"enum": [
"trends",
"time_to_convert",
"steps"
],
"type": "string",
"description": "* `trends` - trends\n* `time_to_convert` - time_to_convert\n* `steps` - steps"
}
FunnelVizTypeNullable
{
"enum": [
"steps",
"time_to_convert",
"trends"
],
"type": "string",
"title": "FunnelVizType",
"default": null,
"nullable": true
}
FunnelWindowIntervalTypeEnum
{
"enum": [
"DAY",
"SECOND",
"MINUTE",
"HOUR",
"WEEK",
"MONTH"
],
"type": "string",
"description": "* `DAY` - DAY\n* `SECOND` - SECOND\n* `MINUTE` - MINUTE\n* `HOUR` - HOUR\n* `WEEK` - WEEK\n* `MONTH` - MONTH"
}
FunnelsActorsQuery
{
"type": "object",
"title": "FunnelsActorsQuery",
"required": [
"source"
],
"properties": {
"kind": {
"const": "FunnelsActorsQuery",
"title": "Kind",
"default": "FunnelsActorsQuery"
},
"source": {
"$ref": "#/components/schemas/FunnelsQuery"
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"funnelStep": {
"type": "integer",
"title": "Funnelstep",
"default": null,
"nullable": true,
"description": "Index of the step for which we want to get the timestamp for, per person. Positive for converted persons, negative for dropped of persons."
},
"funnelCustomSteps": {
"type": "array",
"items": {
"type": "integer"
},
"title": "Funnelcustomsteps",
"default": null,
"nullable": true,
"description": "Custom step numbers to get persons for. This overrides `funnelStep`. Primarily for correlation use."
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
},
"funnelStepBreakdown": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Funnelstepbreakdown",
"default": null,
"nullable": true,
"description": "The breakdown value for which to get persons for. This is an array for person and event properties, a string for groups and an integer for cohorts."
},
"funnelTrendsDropOff": {
"type": "boolean",
"title": "Funneltrendsdropoff",
"default": null,
"nullable": true
},
"funnelTrendsEntrancePeriodStart": {
"type": "string",
"title": "Funneltrendsentranceperiodstart",
"default": null,
"nullable": true,
"description": "Used together with `funnelTrendsDropOff` for funnels time conversion date for the persons modal."
}
}
}
FunnelsFilter
{
"type": "object",
"title": "FunnelsFilter",
"properties": {
"layout": {
"$ref": "#/components/schemas/FunnelLayoutNullable"
},
"binCount": {
"type": "integer",
"title": "Bincount",
"default": null,
"nullable": true
},
"exclusions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/FunnelExclusionEventsNode"
},
{
"$ref": "#/components/schemas/FunnelExclusionActionsNode"
}
]
},
"title": "Exclusions",
"default": null,
"nullable": true
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep",
"default": null,
"nullable": true
},
"funnelVizType": {
"$ref": "#/components/schemas/FunnelVizTypeNullable"
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep",
"default": null,
"nullable": true
},
"funnelOrderType": {
"$ref": "#/components/schemas/StepOrderValueNullable"
},
"funnelStepReference": {
"$ref": "#/components/schemas/FunnelStepReferenceNullable"
},
"funnelWindowInterval": {
"type": "integer",
"title": "Funnelwindowinterval",
"default": null,
"nullable": true
},
"funnelAggregateByHogQL": {
"type": "string",
"title": "Funnelaggregatebyhogql",
"default": null,
"nullable": true
},
"breakdownAttributionType": {
"$ref": "#/components/schemas/BreakdownAttributionTypeNullable"
},
"funnelWindowIntervalUnit": {
"$ref": "#/components/schemas/FunnelConversionWindowTimeUnitNullable"
},
"hidden_legend_breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hidden Legend Breakdowns",
"default": null,
"nullable": true
},
"breakdownAttributionValue": {
"type": "integer",
"title": "Breakdownattributionvalue",
"default": null,
"nullable": true
}
}
}
FunnelsFilterNullable
{
"type": "object",
"title": "FunnelsFilter",
"default": null,
"nullable": true,
"properties": {
"layout": {
"$ref": "#/components/schemas/FunnelLayoutNullable"
},
"binCount": {
"type": "integer",
"title": "Bincount",
"default": null,
"nullable": true
},
"exclusions": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/FunnelExclusionEventsNode"
},
{
"$ref": "#/components/schemas/FunnelExclusionActionsNode"
}
]
},
"title": "Exclusions",
"default": null,
"nullable": true
},
"funnelToStep": {
"type": "integer",
"title": "Funneltostep",
"default": null,
"nullable": true
},
"funnelVizType": {
"$ref": "#/components/schemas/FunnelVizTypeNullable"
},
"funnelFromStep": {
"type": "integer",
"title": "Funnelfromstep",
"default": null,
"nullable": true
},
"funnelOrderType": {
"$ref": "#/components/schemas/StepOrderValueNullable"
},
"funnelStepReference": {
"$ref": "#/components/schemas/FunnelStepReferenceNullable"
},
"funnelWindowInterval": {
"type": "integer",
"title": "Funnelwindowinterval",
"default": null,
"nullable": true
},
"funnelAggregateByHogQL": {
"type": "string",
"title": "Funnelaggregatebyhogql",
"default": null,
"nullable": true
},
"breakdownAttributionType": {
"$ref": "#/components/schemas/BreakdownAttributionTypeNullable"
},
"funnelWindowIntervalUnit": {
"$ref": "#/components/schemas/FunnelConversionWindowTimeUnitNullable"
},
"hidden_legend_breakdowns": {
"type": "array",
"items": {
"type": "string"
},
"title": "Hidden Legend Breakdowns",
"default": null,
"nullable": true
},
"breakdownAttributionValue": {
"type": "integer",
"title": "Breakdownattributionvalue",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the funnels insight"
}
FunnelsQuery
{
"type": "object",
"title": "FunnelsQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "FunnelsQuery",
"title": "Kind",
"default": "FunnelsQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"funnelsFilter": {
"$ref": "#/components/schemas/FunnelsFilterNullable"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"breakdownFilter": {
"$ref": "#/components/schemas/BreakdownFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
}
}
GenericInsights
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterEvent"
},
"description": "Events to filter on. One of `events` or `actions` is required."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAction"
},
"description": "Actions to filter on. One of `events` or `actions` is required."
},
"date_to": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"date_from": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"filter_test_accounts": {
"type": "boolean",
"default": false,
"description": "Whether to filter out internal and test accounts. See \"project settings\" in your PostHog account for the filters."
}
},
"x-konfig-properties": {
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
}
}
}
GoalLine
{
"type": "object",
"title": "GoalLine",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "number",
"title": "Value"
}
}
}
Group
{
"type": "object",
"required": [
"created_at",
"group_key",
"group_type_index"
],
"properties": {
"group_key": {
"type": "string",
"maxLength": 400
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"group_properties": {},
"group_type_index": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
}
}
}
GroupPropertyFilter
{
"type": "object",
"title": "GroupPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "group",
"title": "Type",
"default": "group"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
},
"group_type_index": {
"type": "number",
"title": "Group Type Index",
"default": null,
"nullable": true
}
}
}
GroupType
{
"type": "object",
"required": [
"group_type",
"group_type_index"
],
"properties": {
"group_type": {
"type": "string",
"readOnly": true
},
"name_plural": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"name_singular": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"group_type_index": {
"type": "integer",
"readOnly": true
}
}
}
GroupstypesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupType"
}
}
HogQLAutocomplete
{
"type": "object",
"title": "HogQLAutocomplete",
"required": [
"endPosition",
"select",
"startPosition"
],
"properties": {
"kind": {
"const": "HogQLAutocomplete",
"title": "Kind",
"default": "HogQLAutocomplete"
},
"select": {
"type": "string",
"title": "Select",
"description": "Full select query to validate"
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLAutocompleteResponseNullable"
},
"endPosition": {
"type": "integer",
"title": "Endposition",
"description": "End position of the editor word"
},
"startPosition": {
"type": "integer",
"title": "Startposition",
"description": "Start position of the editor word"
}
}
}
HogQLAutocompleteResponse
{
"type": "object",
"title": "HogQLAutocompleteResponse",
"required": [
"incomplete_list",
"suggestions"
],
"properties": {
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutocompleteCompletionItem"
},
"title": "Suggestions"
},
"incomplete_list": {
"type": "boolean",
"title": "Incomplete List",
"description": "Whether or not the suggestions returned are complete"
}
}
}
HogQLAutocompleteResponseNullable
{
"type": "object",
"title": "HogQLAutocompleteResponse",
"default": null,
"nullable": true,
"required": [
"incomplete_list",
"suggestions"
],
"properties": {
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutocompleteCompletionItem"
},
"title": "Suggestions"
},
"incomplete_list": {
"type": "boolean",
"title": "Incomplete List",
"description": "Whether or not the suggestions returned are complete"
}
},
"description": "Cached query response"
}
HogQLFilters
{
"type": "object",
"title": "HogQLFilters",
"properties": {
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"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
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true
}
}
}
HogQLFiltersNullable
{
"type": "object",
"title": "HogQLFilters",
"default": null,
"nullable": true,
"properties": {
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"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
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true
}
}
}
HogQLMetadata
{
"type": "object",
"title": "HogQLMetadata",
"properties": {
"expr": {
"type": "string",
"title": "Expr",
"default": null,
"nullable": true,
"description": "HogQL expression to validate (use `select` or `expr`, but not both)"
},
"kind": {
"const": "HogQLMetadata",
"title": "Kind",
"default": "HogQLMetadata"
},
"debug": {
"type": "boolean",
"title": "Debug",
"default": null,
"nullable": true,
"description": "Enable more verbose output, usually run from the /debug page"
},
"table": {
"type": "string",
"title": "Table",
"default": null,
"nullable": true,
"description": "Table to validate the expression against"
},
"select": {
"type": "string",
"title": "Select",
"default": null,
"nullable": true,
"description": "Full select query to validate (use `select` or `expr`, but not both)"
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"exprSource": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/PersonsNode"
},
{
"$ref": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
{
"$ref": "#/components/schemas/EventsQuery"
},
{
"$ref": "#/components/schemas/ActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQueryOptions"
},
{
"$ref": "#/components/schemas/SessionsTimelineQuery"
},
{
"$ref": "#/components/schemas/HogQLQuery"
},
{
"$ref": "#/components/schemas/HogQLMetadata"
},
{
"$ref": "#/components/schemas/HogQLAutocomplete"
},
{
"$ref": "#/components/schemas/WebOverviewQuery"
},
{
"$ref": "#/components/schemas/WebStatsTableQuery"
},
{
"$ref": "#/components/schemas/WebTopClicksQuery"
}
],
"title": "Exprsource",
"default": null,
"nullable": true,
"description": "Query within which \"expr\" is validated. Defaults to \"select * from events\""
}
}
}
HogQLMetadataResponse
{
"type": "object",
"title": "HogQLMetadataResponse",
"required": [
"errors",
"notices",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Errors"
},
"isValid": {
"type": "boolean",
"title": "Isvalid",
"default": null,
"nullable": true
},
"notices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Notices"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Warnings"
},
"inputExpr": {
"type": "string",
"title": "Inputexpr",
"default": null,
"nullable": true
},
"inputSelect": {
"type": "string",
"title": "Inputselect",
"default": null,
"nullable": true
},
"isValidView": {
"type": "boolean",
"title": "Isvalidview",
"default": null,
"nullable": true
}
}
}
HogQLMetadataResponseNullable
{
"type": "object",
"title": "HogQLMetadataResponse",
"default": null,
"nullable": true,
"required": [
"errors",
"notices",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Errors"
},
"isValid": {
"type": "boolean",
"title": "Isvalid",
"default": null,
"nullable": true
},
"notices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Notices"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Warnings"
},
"inputExpr": {
"type": "string",
"title": "Inputexpr",
"default": null,
"nullable": true
},
"inputSelect": {
"type": "string",
"title": "Inputselect",
"default": null,
"nullable": true
},
"isValidView": {
"type": "boolean",
"title": "Isvalidview",
"default": null,
"nullable": true
}
},
"description": "Query metadata output"
}
HogQLNotice
{
"type": "object",
"title": "HogQLNotice",
"required": [
"message"
],
"properties": {
"end": {
"type": "integer",
"title": "End",
"default": null,
"nullable": true
},
"fix": {
"type": "string",
"title": "Fix",
"default": null,
"nullable": true
},
"start": {
"type": "integer",
"title": "Start",
"default": null,
"nullable": true
},
"message": {
"type": "string",
"title": "Message"
}
}
}
HogQLPropertyFilter
{
"type": "object",
"title": "HogQLPropertyFilter",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "hogql",
"title": "Type",
"default": "hogql"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
}
}
}
HogQLQuery
{
"type": "object",
"title": "HogQLQuery",
"required": [
"query"
],
"properties": {
"kind": {
"const": "HogQLQuery",
"title": "Kind",
"default": "HogQLQuery"
},
"query": {
"type": "string",
"title": "Query"
},
"values": {
"type": "object",
"title": "Values",
"default": null,
"nullable": true,
"description": "Constant values that can be referenced with the {placeholder} syntax in the query"
},
"explain": {
"type": "boolean",
"title": "Explain",
"default": null,
"nullable": true
},
"filters": {
"$ref": "#/components/schemas/HogQLFiltersNullable"
},
"response": {
"$ref": "#/components/schemas/HogQLQueryResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
}
}
}
HogQLQueryModifiers
{
"type": "object",
"title": "HogQLQueryModifiers",
"properties": {
"inCohortVia": {
"$ref": "#/components/schemas/InCohortViaNullable"
},
"materializationMode": {
"$ref": "#/components/schemas/MaterializationModeNullable"
},
"personsOnEventsMode": {
"$ref": "#/components/schemas/PersonsOnEventsModeNullable"
},
"personsArgMaxVersion": {
"$ref": "#/components/schemas/PersonsArgMaxVersionNullable"
},
"dataWarehouseEventsModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataWarehouseEventsModifier"
},
"title": "Datawarehouseeventsmodifiers",
"default": null,
"nullable": true
}
}
}
HogQLQueryModifiersNullable
{
"type": "object",
"title": "HogQLQueryModifiers",
"default": null,
"nullable": true,
"properties": {
"inCohortVia": {
"$ref": "#/components/schemas/InCohortViaNullable"
},
"materializationMode": {
"$ref": "#/components/schemas/MaterializationModeNullable"
},
"personsOnEventsMode": {
"$ref": "#/components/schemas/PersonsOnEventsModeNullable"
},
"personsArgMaxVersion": {
"$ref": "#/components/schemas/PersonsArgMaxVersionNullable"
},
"dataWarehouseEventsModifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataWarehouseEventsModifier"
},
"title": "Datawarehouseeventsmodifiers",
"default": null,
"nullable": true
}
},
"description": "Modifiers used when performing the query"
}
HogQLQueryResponse
{
"type": "object",
"title": "HogQLQueryResponse",
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": null,
"nullable": true,
"description": "Query error. Returned only if 'explain' is true. Throws an error otherwise."
},
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true,
"description": "Generated HogQL query"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"query": {
"type": "string",
"title": "Query",
"default": null,
"nullable": true,
"description": "Input query string"
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true,
"description": "Types of returned columns"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Returned columns"
},
"explain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Explain",
"default": null,
"nullable": true,
"description": "Query explanation output"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results",
"default": null,
"nullable": true,
"description": "Query results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"metadata": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
},
"clickhouse": {
"type": "string",
"title": "Clickhouse",
"default": null,
"nullable": true,
"description": "Executed ClickHouse query"
}
}
}
HogQLQueryResponseNullable
{
"type": "object",
"title": "HogQLQueryResponse",
"default": null,
"nullable": true,
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": null,
"nullable": true,
"description": "Query error. Returned only if 'explain' is true. Throws an error otherwise."
},
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true,
"description": "Generated HogQL query"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"query": {
"type": "string",
"title": "Query",
"default": null,
"nullable": true,
"description": "Input query string"
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true,
"description": "Types of returned columns"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Returned columns"
},
"explain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Explain",
"default": null,
"nullable": true,
"description": "Query explanation output"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results",
"default": null,
"nullable": true,
"description": "Query results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"metadata": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
},
"clickhouse": {
"type": "string",
"title": "Clickhouse",
"default": null,
"nullable": true,
"description": "Executed ClickHouse query"
}
},
"description": "Cached query response"
}
InCohortVia
{
"enum": [
"auto",
"leftjoin",
"subquery",
"leftjoin_conjoined"
],
"type": "string",
"title": "InCohortVia"
}
InCohortViaNullable
{
"enum": [
"auto",
"leftjoin",
"subquery",
"leftjoin_conjoined"
],
"type": "string",
"title": "InCohortVia",
"default": null,
"nullable": true
}
Insight
{
"type": "object",
"required": [
"created_at",
"created_by",
"dashboard_tiles",
"effective_privilege_level",
"effective_restriction_level",
"id",
"is_cached",
"is_sample",
"last_modified_at",
"last_modified_by",
"last_refresh",
"next_allowed_client_refresh",
"result",
"short_id",
"timezone",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"query": {
"nullable": true,
"description": "Query node JSON string"
},
"saved": {
"type": "boolean"
},
"result": {
"type": "string",
"readOnly": true
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"timezone": {
"type": "string",
"readOnly": true,
"description": "The timezone this chart is displayed in."
},
"favorited": {
"type": "boolean"
},
"is_cached": {
"type": "string",
"readOnly": true
},
"is_sample": {
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"dashboards": {
"type": "array",
"items": {
"type": "integer"
},
"description": "\n DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.\n A dashboard ID for each of the dashboards that this insight is displayed on.\n "
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The datetime this insight's results were generated.\n If added to one or more dashboards the insight can be refreshed separately on each.\n Returns the appropriate last_refresh datetime for the context the insight is viewed in\n (see from_dashboard query parameter).\n "
},
"dashboard_tiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTileBasic"
},
"readOnly": true,
"description": "\n A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.\n "
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
},
"effective_privilege_level": {
"$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
},
"effective_restriction_level": {
"$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
},
"next_allowed_client_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed\n by querying the database.\n "
}
},
"description": "Simplified serializer to speed response times when loading large amounts of objects.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
},
"effective_privilege_level": {
"readOnly": true
},
"effective_restriction_level": {
"readOnly": true
}
}
}
InsightActorsQuery
{
"type": "object",
"title": "InsightActorsQuery",
"required": [
"source"
],
"properties": {
"day": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Day",
"default": null,
"nullable": true
},
"kind": {
"const": "InsightActorsQuery",
"title": "Kind",
"default": "InsightActorsQuery"
},
"series": {
"type": "integer",
"title": "Series",
"default": null,
"nullable": true
},
"source": {
"oneOf": [
{
"$ref": "#/components/schemas/TrendsQuery"
},
{
"$ref": "#/components/schemas/FunnelsQuery"
},
{
"$ref": "#/components/schemas/RetentionQuery"
},
{
"$ref": "#/components/schemas/PathsQuery"
},
{
"$ref": "#/components/schemas/StickinessQuery"
},
{
"$ref": "#/components/schemas/LifecycleQuery"
}
],
"title": "Source",
"discriminator": {
"mapping": {
"PathsQuery": "#/components/schemas/PathsQuery",
"TrendsQuery": "#/components/schemas/TrendsQuery",
"FunnelsQuery": "#/components/schemas/FunnelsQuery",
"LifecycleQuery": "#/components/schemas/LifecycleQuery",
"RetentionQuery": "#/components/schemas/RetentionQuery",
"StickinessQuery": "#/components/schemas/StickinessQuery"
},
"propertyName": "kind"
}
},
"status": {
"type": "string",
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"$ref": "#/components/schemas/CompareNullable"
},
"interval": {
"type": "integer",
"title": "Interval",
"default": null,
"nullable": true,
"description": "An interval selected out of available intervals in source query."
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"breakdown": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Breakdown",
"default": null,
"nullable": true
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
}
}
}
InsightActorsQueryOptions
{
"type": "object",
"title": "InsightActorsQueryOptions",
"required": [
"source"
],
"properties": {
"kind": {
"const": "InsightActorsQueryOptions",
"title": "Kind",
"default": "InsightActorsQueryOptions"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/InsightActorsQuery"
},
{
"$ref": "#/components/schemas/FunnelsActorsQuery"
},
{
"$ref": "#/components/schemas/FunnelCorrelationActorsQuery"
}
],
"title": "Source"
},
"response": {
"$ref": "#/components/schemas/InsightActorsQueryOptionsResponseNullable"
}
}
}
InsightActorsQueryOptionsResponse
{
"type": "object",
"title": "InsightActorsQueryOptionsResponse",
"properties": {
"day": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayItem"
},
"title": "Day",
"default": null,
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"title": "Series",
"default": null,
"nullable": true
},
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusItem"
},
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareItem"
},
"title": "Compare",
"default": null,
"nullable": true
},
"interval": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntervalItem"
},
"title": "Interval",
"default": null,
"nullable": true
},
"breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
},
"title": "Breakdown",
"default": null,
"nullable": true
}
}
}
InsightActorsQueryOptionsResponseNullable
{
"type": "object",
"title": "InsightActorsQueryOptionsResponse",
"default": null,
"nullable": true,
"properties": {
"day": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayItem"
},
"title": "Day",
"default": null,
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"title": "Series",
"default": null,
"nullable": true
},
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusItem"
},
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareItem"
},
"title": "Compare",
"default": null,
"nullable": true
},
"interval": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntervalItem"
},
"title": "Interval",
"default": null,
"nullable": true
},
"breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
},
"title": "Breakdown",
"default": null,
"nullable": true
}
}
}
InsightVizNode
{
"type": "object",
"title": "InsightVizNode",
"required": [
"source"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in insight scene."
},
"kind": {
"const": "InsightVizNode",
"title": "Kind",
"default": "InsightVizNode"
},
"source": {
"oneOf": [
{
"$ref": "#/components/schemas/TrendsQuery"
},
{
"$ref": "#/components/schemas/FunnelsQuery"
},
{
"$ref": "#/components/schemas/RetentionQuery"
},
{
"$ref": "#/components/schemas/PathsQuery"
},
{
"$ref": "#/components/schemas/StickinessQuery"
},
{
"$ref": "#/components/schemas/LifecycleQuery"
}
],
"title": "Source",
"discriminator": {
"mapping": {
"PathsQuery": "#/components/schemas/PathsQuery",
"TrendsQuery": "#/components/schemas/TrendsQuery",
"FunnelsQuery": "#/components/schemas/FunnelsQuery",
"LifecycleQuery": "#/components/schemas/LifecycleQuery",
"RetentionQuery": "#/components/schemas/RetentionQuery",
"StickinessQuery": "#/components/schemas/StickinessQuery"
},
"propertyName": "kind"
}
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Query is embedded inside another bordered component"
},
"showTable": {
"type": "boolean",
"title": "Showtable",
"default": null,
"nullable": true
},
"showHeader": {
"type": "boolean",
"title": "Showheader",
"default": null,
"nullable": true
},
"showFilters": {
"type": "boolean",
"title": "Showfilters",
"default": null,
"nullable": true
},
"showResults": {
"type": "boolean",
"title": "Showresults",
"default": null,
"nullable": true
},
"hidePersonsModal": {
"type": "boolean",
"title": "Hidepersonsmodal",
"default": null,
"nullable": true
},
"vizSpecificOptions": {
"$ref": "#/components/schemas/VizSpecificOptionsNullable"
},
"showLastComputation": {
"type": "boolean",
"title": "Showlastcomputation",
"default": null,
"nullable": true
},
"showCorrelationTable": {
"type": "boolean",
"title": "Showcorrelationtable",
"default": null,
"nullable": true
},
"showLastComputationRefresh": {
"type": "boolean",
"title": "Showlastcomputationrefresh",
"default": null,
"nullable": true
},
"suppressSessionAnalysisWarning": {
"type": "boolean",
"title": "Suppresssessionanalysiswarning",
"default": null,
"nullable": true
}
}
}
InsightsGetSharingResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
IntervalEnum
{
"enum": [
"hour",
"day",
"week",
"every 5 minutes"
],
"type": "string",
"description": "* `hour` - hour\n* `day` - day\n* `week` - week\n* `every 5 minutes` - every 5 minutes"
}
IntervalItem
{
"type": "object",
"title": "IntervalItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "integer",
"title": "Value",
"description": "An interval selected out of available intervals in source query"
}
}
}
IntervalType
{
"enum": [
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "IntervalType"
}
IntervalTypeNullable
{
"enum": [
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "IntervalType",
"default": null,
"nullable": true,
"description": "Granularity of the response. Can be one of `hour`, `day`, `week` or `month`"
}
Key
{
"enum": [
"tag_name",
"text",
"href",
"selector"
],
"type": "string",
"title": "Key"
}
Kind
{
"enum": [
"Method",
"Function",
"Constructor",
"Field",
"Variable",
"Class",
"Struct",
"Interface",
"Module",
"Property",
"Event",
"Operator",
"Unit",
"Value",
"Constant",
"Enum",
"EnumMember",
"Keyword",
"Text",
"Color",
"File",
"Reference",
"Customcolor",
"Folder",
"TypeParameter",
"User",
"Issue",
"Snippet"
],
"type": "string",
"title": "Kind"
}
Kind1
{
"enum": [
"ActionsNode",
"EventsNode"
],
"type": "string",
"title": "Kind1"
}
Kind1Nullable
{
"enum": [
"ActionsNode",
"EventsNode"
],
"type": "string",
"title": "Kind1",
"default": null,
"nullable": true
}
Kind2
{
"enum": [
"unit",
"duration_s",
"percentage"
],
"type": "string",
"title": "Kind2"
}
LevelD7eEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Everyone in the project can edit\n* `37` - Only those invited to this dashboard can edit"
}
LifecycleFilter
{
"type": "object",
"title": "LifecycleFilter",
"properties": {
"toggledLifecycles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifecycleToggle"
},
"title": "Toggledlifecycles",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
}
}
}
LifecycleFilterNullable
{
"type": "object",
"title": "LifecycleFilter",
"default": null,
"nullable": true,
"properties": {
"toggledLifecycles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifecycleToggle"
},
"title": "Toggledlifecycles",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the lifecycle insight"
}
LifecycleQuery
{
"type": "object",
"title": "LifecycleQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "LifecycleQuery",
"title": "Kind",
"default": "LifecycleQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"response": {
"$ref": "#/components/schemas/LifecycleQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"lifecycleFilter": {
"$ref": "#/components/schemas/LifecycleFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
}
}
}
LifecycleQueryResponse
{
"type": "object",
"title": "LifecycleQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
LifecycleQueryResponseNullable
{
"type": "object",
"title": "LifecycleQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
LifecycleToggle
{
"enum": [
"new",
"resurrecting",
"returning",
"dormant"
],
"type": "string",
"title": "LifecycleToggle"
}
MaterializationMode
{
"enum": [
"auto",
"legacy_null_as_string",
"legacy_null_as_null",
"disabled"
],
"type": "string",
"title": "MaterializationMode"
}
MaterializationModeNullable
{
"enum": [
"auto",
"legacy_null_as_string",
"legacy_null_as_null",
"disabled"
],
"type": "string",
"title": "MaterializationMode",
"default": null,
"nullable": true
}
MathEnum
{
"enum": [
"total",
"dau",
"weekly_active",
"monthly_active",
"unique_group",
"unique_session",
"sum",
"min",
"max",
"avg",
"median",
"p90",
"p95",
"p99",
"min_count_per_actor",
"max_count_per_actor",
"avg_count_per_actor",
"median_count_per_actor",
"p90_count_per_actor",
"p95_count_per_actor",
"p99_count_per_actor",
"hogql"
],
"type": "string",
"description": "* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
MathGroupTypeIndex
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"title": "MathGroupTypeIndex"
}
MathGroupTypeIndexNullable
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"title": "MathGroupTypeIndex",
"default": null,
"nullable": true
}
MinimalFeatureFlag
{
"type": "object",
"required": [
"id",
"key",
"team_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"team_id": {
"type": "integer",
"readOnly": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
}
}
MinimalPerson
{
"type": "object",
"required": [
"created_at",
"distinct_ids",
"id",
"name",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "string",
"readOnly": true
}
}
}
Notebook
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"last_modified_at",
"last_modified_by",
"short_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 256
},
"content": {
"nullable": true
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"text_content": {
"type": "string",
"nullable": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
NotebookMinimal
{
"type": "object",
"required": [
"created_at",
"created_by",
"deleted",
"id",
"last_modified_at",
"last_modified_by",
"short_id",
"title"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deleted": {
"type": "boolean",
"readOnly": true
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
NullEnum
{
"enum": [
null
],
"type": "object"
}
OperatorEnum
{
"enum": [
"exact",
"is_not",
"icontains",
"not_icontains",
"regex",
"not_regex",
"gt",
"lt",
"gte",
"lte",
"is_set",
"is_not_set",
"is_date_exact",
"is_date_after",
"is_date_before"
],
"type": "string",
"description": "* `exact` - exact\n* `is_not` - is_not\n* `icontains` - icontains\n* `not_icontains` - not_icontains\n* `regex` - regex\n* `not_regex` - not_regex\n* `gt` - gt\n* `lt` - lt\n* `gte` - gte\n* `lte` - lte\n* `is_set` - is_set\n* `is_not_set` - is_not_set\n* `is_date_exact` - is_date_exact\n* `is_date_after` - is_date_after\n* `is_date_before` - is_date_before"
}
Organization
{
"type": "object",
"required": [
"available_features",
"available_product_features",
"created_at",
"customer_id",
"id",
"member_count",
"membership_level",
"metadata",
"name",
"plugins_access_level",
"slug",
"teams",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true
},
"teams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"readOnly": true
},
"metadata": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customer_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enforce_2fa": {
"type": "boolean",
"nullable": true
},
"member_count": {
"type": "string",
"readOnly": true
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"available_features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"readOnly": true
},
"plugins_access_level": {
"$ref": "#/components/schemas/PluginsAccessLevelEnum"
},
"available_product_features": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"is_member_join_email_enabled": {
"type": "boolean"
}
},
"x-konfig-properties": {
"plugins_access_level": {
"readOnly": true
}
}
}
OrganizationBasic
{
"type": "object",
"required": [
"id",
"membership_level",
"name",
"slug"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"maxLength": 48
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
}
},
"description": "Serializer for `Organization` model with minimal attributes to speeed up loading and transfer times.\nAlso used for nested serializers."
}
OrganizationDomain
{
"type": "object",
"required": [
"domain",
"has_saml",
"id",
"is_verified",
"verification_challenge",
"verified_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"domain": {
"type": "string",
"maxLength": 128
},
"has_saml": {
"type": "boolean",
"readOnly": true,
"description": "Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places)."
},
"is_verified": {
"type": "boolean",
"readOnly": true,
"description": "Determines whether a domain is verified or not."
},
"verified_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"saml_acs_url": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_entity_id": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_x509_cert": {
"type": "string",
"nullable": true
},
"sso_enforcement": {
"type": "string",
"maxLength": 28
},
"verification_challenge": {
"type": "string",
"readOnly": true
},
"jit_provisioning_enabled": {
"type": "boolean"
}
}
}
OrganizationInvite
{
"type": "object",
"required": [
"created_at",
"created_by",
"emailing_attempt_made",
"id",
"is_expired",
"target_email",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"message": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"first_name": {
"type": "string",
"maxLength": 30
},
"is_expired": {
"type": "boolean",
"readOnly": true,
"description": "Check if invite is older than INVITE_DAYS_VALIDITY days."
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"target_email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"emailing_attempt_made": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
OrganizationMember
{
"type": "object",
"required": [
"has_social_auth",
"id",
"is_2fa_enabled",
"joined_at",
"updated_at",
"user"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/OrganizationMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
}
}
}
OrganizationMemberLevelEnum
{
"enum": [
1,
8,
15
],
"type": "integer",
"description": "* `1` - member\n* `8` - administrator\n* `15` - owner"
}
PaginatedActionList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Action"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedActivityLogList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityLog"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedAnnotationList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExport"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportLogEntryList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExportLogEntry"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportRunList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedClickhouseEventList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
}
}
}
PaginatedCohortList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cohort"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedDashboardBasicList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardBasic"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedDashboardTemplateList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedEarlyAccessFeatureList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedExperimentList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Experiment"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedExportedAssetList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedFeatureFlagList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedFeatureFlagRoleAccessList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedGroupList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedInsightList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insight"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedNotebookMinimalList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookMinimal"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationDomainList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationInviteList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationMemberList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPersonList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 400
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
"nullable": true
}
}
}
PaginatedPluginConfigList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginConfig"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPluginList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plugin"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPluginLogEntryList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginLogEntry"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedRoleList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedRoleMembershipList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleMembership"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSessionRecordingList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSessionRecordingPlaylistList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSubscriptionList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSurveyList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Survey"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedTeamBasicList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamBasic"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedUserList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PatchedAction
{
"type": "object",
"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
}
}
}
PatchedAnnotation
{
"type": "object",
"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
}
}
}
PatchedBatchExport
{
"type": "object",
"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."
}
PatchedCohort
{
"type": "object",
"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
}
}
}
PatchedDashboard
{
"type": "object",
"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
}
}
}
PatchedDashboardTemplate
{
"type": "object",
"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
}
}
}
PatchedEarlyAccessFeature
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
PatchedExperiment
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"filters": {},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"parameters": {
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_key": {
"type": "string"
},
"secondary_metrics": {
"nullable": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
PatchedExplicitTeamMember
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/ExplicitTeamMemberLevelEnum"
},
"joined_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
},
"parent_level": {
"type": "integer",
"readOnly": true
},
"effective_level": {
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
},
"parent_membership_id": {
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
},
"effective_level": {
"readOnly": true,
"description": "If organization level is higher than project level, then that takes precedence over explicit project level."
}
}
}
PatchedFeatureFlag
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string",
"description": "contains the description for the flag (field name `name` is kept for backwards-compatibility)"
},
"tags": {
"type": "array",
"items": {}
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"surveys": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"can_edit": {
"type": "boolean",
"readOnly": true
},
"features": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"experiment_set": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
},
"is_simple_flag": {
"type": "boolean",
"readOnly": true
},
"usage_dashboard": {
"type": "integer",
"readOnly": true
},
"performed_rollback": {
"type": "boolean",
"nullable": true
},
"rollout_percentage": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"rollback_conditions": {
"nullable": true
},
"analytics_dashboards": {
"type": "array",
"items": {
"type": "integer"
}
},
"has_enriched_analytics": {
"type": "boolean",
"nullable": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedGroupType
{
"type": "object",
"properties": {
"group_type": {
"type": "string",
"readOnly": true
},
"name_plural": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"name_singular": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"group_type_index": {
"type": "integer",
"readOnly": true
}
}
}
PatchedInsight
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"query": {
"nullable": true,
"description": "Query node JSON string"
},
"saved": {
"type": "boolean"
},
"result": {
"type": "string",
"readOnly": true
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"timezone": {
"type": "string",
"readOnly": true,
"description": "The timezone this chart is displayed in."
},
"favorited": {
"type": "boolean"
},
"is_cached": {
"type": "string",
"readOnly": true
},
"is_sample": {
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"dashboards": {
"type": "array",
"items": {
"type": "integer"
},
"description": "\n DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.\n A dashboard ID for each of the dashboards that this insight is displayed on.\n "
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The datetime this insight's results were generated.\n If added to one or more dashboards the insight can be refreshed separately on each.\n Returns the appropriate last_refresh datetime for the context the insight is viewed in\n (see from_dashboard query parameter).\n "
},
"dashboard_tiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTileBasic"
},
"readOnly": true,
"description": "\n A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.\n "
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
},
"effective_privilege_level": {
"$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
},
"effective_restriction_level": {
"$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
},
"next_allowed_client_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed\n by querying the database.\n "
}
},
"description": "Simplified serializer to speed response times when loading large amounts of objects.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
},
"effective_privilege_level": {
"readOnly": true
},
"effective_restriction_level": {
"readOnly": true
}
}
}
PatchedNotebook
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 256
},
"content": {
"nullable": true
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"text_content": {
"type": "string",
"nullable": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
PatchedOrganization
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true
},
"teams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"readOnly": true
},
"metadata": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customer_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enforce_2fa": {
"type": "boolean",
"nullable": true
},
"member_count": {
"type": "string",
"readOnly": true
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"available_features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"readOnly": true
},
"plugins_access_level": {
"$ref": "#/components/schemas/PluginsAccessLevelEnum"
},
"available_product_features": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"is_member_join_email_enabled": {
"type": "boolean"
}
},
"x-konfig-properties": {
"plugins_access_level": {
"readOnly": true
}
}
}
PatchedOrganizationDomain
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"domain": {
"type": "string",
"maxLength": 128
},
"has_saml": {
"type": "boolean",
"readOnly": true,
"description": "Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places)."
},
"is_verified": {
"type": "boolean",
"readOnly": true,
"description": "Determines whether a domain is verified or not."
},
"verified_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"saml_acs_url": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_entity_id": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_x509_cert": {
"type": "string",
"nullable": true
},
"sso_enforcement": {
"type": "string",
"maxLength": 28
},
"verification_challenge": {
"type": "string",
"readOnly": true
},
"jit_provisioning_enabled": {
"type": "boolean"
}
}
}
PatchedOrganizationMember
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/OrganizationMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
}
}
}
PatchedPerson
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
PatchedPlugin
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"tag": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"url": {
"type": "string",
"nullable": true,
"readOnly": true
},
"icon": {
"type": "string",
"nullable": true,
"maxLength": 800
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"metrics": {
"nullable": true
},
"is_global": {
"type": "boolean"
},
"latest_tag": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true
},
"plugin_type": {
"oneOf": [
{
"$ref": "#/components/schemas/PluginTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"public_jobs": {
"nullable": true
},
"capabilities": {},
"config_schema": {},
"organization_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"organization_name": {
"type": "string",
"readOnly": true
}
}
}
PatchedPluginConfig
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"error": {
"type": "string",
"readOnly": true
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"config": {
"type": "string",
"readOnly": true
},
"plugin": {
"type": "integer"
},
"deleted": {
"type": "boolean",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"team_id": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 1000
},
"plugin_info": {
"type": "string",
"readOnly": true
},
"delivery_rate_24h": {
"type": "string",
"readOnly": true
}
}
}
PatchedRole
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"members": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"associated_flags": {
"type": "string",
"readOnly": true
},
"feature_flags_access_level": {
"$ref": "#/components/schemas/FeatureFlagsAccessLevelEnum"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flags_access_level": {
"maximum": 32767,
"minimum": 0
}
}
}
PatchedSessionRecordingPlaylist
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"pinned": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
PatchedSubscription
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 100
},
"deleted": {
"type": "boolean"
},
"insight": {
"type": "integer",
"nullable": true
},
"summary": {
"type": "string",
"readOnly": true
},
"bysetpos": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"interval": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"byweekday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ByweekdayEnum"
},
"nullable": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"frequency": {
"$ref": "#/components/schemas/FrequencyEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"until_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"target_type": {
"$ref": "#/components/schemas/TargetTypeEnum"
},
"target_value": {
"type": "string"
},
"invite_message": {
"type": "string",
"nullable": true
},
"next_delivery_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
}
},
"description": "Standard Subscription serializer.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedSurveySerializerCreateUpdateOnly
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true,
"writeOnly": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"targeting_flag_id": {
"type": "integer",
"writeOnly": true
},
"remove_targeting_flag": {
"type": "boolean",
"nullable": true,
"writeOnly": true
},
"targeting_flag_filters": {
"nullable": true,
"writeOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
PatchedTeam
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean"
},
"app_urls": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"anonymize_ips": {
"type": "boolean"
},
"access_control": {
"type": "boolean"
},
"extra_settings": {
"nullable": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"surveys_opt_in": {
"type": "boolean",
"nullable": true
},
"week_start_day": {
"oneOf": [
{
"$ref": "#/components/schemas/WeekStartDayEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"maximum": 32767,
"minimum": -32768,
"nullable": true
},
"data_attributes": {},
"has_group_types": {
"type": "boolean",
"readOnly": true
},
"inject_web_apps": {
"type": "boolean",
"nullable": true
},
"primary_dashboard": {
"type": "integer",
"nullable": true
},
"recording_domains": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"nullable": true
},
"correlation_config": {
"nullable": true
},
"autocapture_opt_out": {
"type": "boolean",
"nullable": true
},
"live_events_columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"test_account_filters": {},
"path_cleaning_filters": {
"nullable": true
},
"session_replay_config": {
"nullable": true
},
"slack_incoming_webhook": {
"type": "string",
"nullable": true,
"maxLength": 500
},
"session_recording_opt_in": {
"type": "boolean"
},
"capture_console_log_opt_in": {
"type": "boolean",
"nullable": true
},
"capture_performance_opt_in": {
"type": "boolean",
"nullable": true
},
"effective_membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean"
},
"has_completed_onboarding_for": {
"nullable": true
},
"autocapture_exceptions_opt_in": {
"type": "boolean",
"nullable": true
},
"session_recording_linked_flag": {
"nullable": true
},
"session_recording_sample_rate": {
"type": "string",
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$",
"nullable": true
},
"person_display_name_properties": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400
},
"nullable": true
},
"groups_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"person_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"test_account_filters_default_checked": {
"type": "boolean",
"nullable": true
},
"autocapture_exceptions_errors_to_ignore": {
"nullable": true
},
"session_recording_minimum_duration_milliseconds": {
"type": "integer",
"maximum": 15000,
"minimum": 0,
"nullable": true
},
"session_recording_network_payload_capture_config": {
"nullable": true
}
}
}
PatchedUser
{
"type": "object",
"properties": {
"team": {
"$ref": "#/components/schemas/TeamBasic"
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"email": {
"type": "string",
"title": "Email address",
"format": "email",
"maxLength": 254
},
"is_staff": {
"type": "boolean",
"title": "Staff status",
"description": "Designates whether the user can log into this admin site."
},
"password": {
"type": "string",
"maxLength": 128,
"writeOnly": true
},
"last_name": {
"type": "string",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 150
},
"theme_mode": {
"oneOf": [
{
"$ref": "#/components/schemas/ThemeModeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"date_joined": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"distinct_id": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"email_opt_in": {
"type": "boolean",
"nullable": true
},
"has_password": {
"type": "boolean",
"readOnly": true
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"toolbar_mode": {
"oneOf": [
{
"$ref": "#/components/schemas/ToolbarModeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationBasic"
},
"readOnly": true
},
"pending_email": {
"type": "string",
"title": "Pending email address awaiting verification",
"format": "email",
"nullable": true,
"maxLength": 254
},
"anonymize_data": {
"type": "boolean",
"nullable": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
},
"is_impersonated": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"current_password": {
"type": "string",
"writeOnly": true
},
"set_current_team": {
"type": "string",
"writeOnly": true
},
"is_email_verified": {
"type": "boolean",
"nullable": true
},
"events_column_config": {},
"notification_settings": {
"type": "object",
"additionalProperties": {}
},
"scene_personalisation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScenePersonalisationBasic"
},
"readOnly": true
},
"set_current_organization": {
"type": "string",
"writeOnly": true
},
"has_seen_product_intro_for": {
"nullable": true
}
},
"x-konfig-properties": {
"team": {
"readOnly": true
},
"organization": {
"readOnly": true
}
}
}
PathCleaningFilter
{
"type": "object",
"title": "PathCleaningFilter",
"properties": {
"alias": {
"type": "string",
"title": "Alias",
"default": null,
"nullable": true
},
"regex": {
"type": "string",
"title": "Regex",
"default": null,
"nullable": true
}
}
}
PathType
{
"enum": [
"$pageview",
"$screen",
"custom_event",
"hogql"
],
"type": "string",
"title": "PathType"
}
PathsFilter
{
"type": "object",
"title": "PathsFilter",
"properties": {
"endPoint": {
"type": "string",
"title": "Endpoint",
"default": null,
"nullable": true
},
"edgeLimit": {
"type": "integer",
"title": "Edgelimit",
"default": null,
"nullable": true
},
"stepLimit": {
"type": "integer",
"title": "Steplimit",
"default": null,
"nullable": true
},
"pathEndKey": {
"type": "string",
"title": "Pathendkey",
"default": null,
"nullable": true,
"description": "Relevant only within actors query"
},
"startPoint": {
"type": "string",
"title": "Startpoint",
"default": null,
"nullable": true
},
"pathStartKey": {
"type": "string",
"title": "Pathstartkey",
"default": null,
"nullable": true,
"description": "Relevant only within actors query"
},
"excludeEvents": {
"type": "array",
"items": {
"type": "string"
},
"title": "Excludeevents",
"default": null,
"nullable": true
},
"maxEdgeWeight": {
"type": "integer",
"title": "Maxedgeweight",
"default": null,
"nullable": true
},
"minEdgeWeight": {
"type": "integer",
"title": "Minedgeweight",
"default": null,
"nullable": true
},
"pathGroupings": {
"type": "array",
"items": {
"type": "string"
},
"title": "Pathgroupings",
"default": null,
"nullable": true
},
"pathDropoffKey": {
"type": "string",
"title": "Pathdropoffkey",
"default": null,
"nullable": true,
"description": "Relevant only within actors query"
},
"pathReplacements": {
"type": "boolean",
"title": "Pathreplacements",
"default": null,
"nullable": true
},
"includeEventTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PathType"
},
"title": "Includeeventtypes",
"default": null,
"nullable": true
},
"pathsHogQLExpression": {
"type": "string",
"title": "Pathshogqlexpression",
"default": null,
"nullable": true
},
"localPathCleaningFilters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PathCleaningFilter"
},
"title": "Localpathcleaningfilters",
"default": null,
"nullable": true
}
}
}
PathsQuery
{
"type": "object",
"title": "PathsQuery",
"required": [
"pathsFilter"
],
"properties": {
"kind": {
"const": "PathsQuery",
"title": "Kind",
"default": "PathsQuery"
},
"response": {
"$ref": "#/components/schemas/PathsQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"pathsFilter": {
"$ref": "#/components/schemas/PathsFilter"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"funnelPathsFilter": {
"$ref": "#/components/schemas/FunnelPathsFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
},
"x-konfig-properties": {
"pathsFilter": {
"description": "Properties specific to the paths insight"
}
}
}
PathsQueryResponse
{
"type": "object",
"title": "PathsQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
PathsQueryResponseNullable
{
"type": "object",
"title": "PathsQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
Person
{
"type": "object",
"required": [
"created_at",
"distinct_ids",
"id",
"name",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
PersonNullable
{
"type": "object",
"default": null,
"nullable": true,
"required": [
"created_at",
"distinct_ids",
"id",
"name",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
PersonPropertyFilter
{
"type": "object",
"title": "PersonPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "person",
"title": "Type",
"default": "person",
"description": "Person properties"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
PersonsArgMaxVersion
{
"enum": [
"auto",
"v1",
"v2"
],
"type": "string",
"title": "PersonsArgMaxVersion"
}
PersonsArgMaxVersionNullable
{
"enum": [
"auto",
"v1",
"v2"
],
"type": "string",
"title": "PersonsArgMaxVersion",
"default": null,
"nullable": true
}
PersonsNode
{
"type": "object",
"title": "PersonsNode",
"properties": {
"kind": {
"const": "PersonsNode",
"title": "Kind",
"default": "PersonsNode"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"cohort": {
"type": "integer",
"title": "Cohort",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"search": {
"type": "string",
"title": "Search",
"default": null,
"nullable": true
},
"response": {
"type": "object",
"title": "Response",
"default": null,
"nullable": true,
"description": "Cached query response"
},
"distinctId": {
"type": "string",
"title": "Distinctid",
"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"
},
"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)"
}
}
}
PersonsOnEventsMode
{
"enum": [
"disabled",
"person_id_no_override_properties_on_events",
"person_id_override_properties_on_events",
"person_id_override_properties_joined"
],
"type": "string",
"title": "PersonsOnEventsMode"
}
PersonsOnEventsModeNullable
{
"enum": [
"disabled",
"person_id_no_override_properties_on_events",
"person_id_override_properties_on_events",
"person_id_override_properties_joined"
],
"type": "string",
"title": "PersonsOnEventsMode",
"default": null,
"nullable": true
}
Plugin
{
"type": "object",
"required": [
"id",
"latest_tag",
"organization_id",
"organization_name",
"url"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"tag": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"url": {
"type": "string",
"nullable": true,
"readOnly": true
},
"icon": {
"type": "string",
"nullable": true,
"maxLength": 800
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"metrics": {
"nullable": true
},
"is_global": {
"type": "boolean"
},
"latest_tag": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true
},
"plugin_type": {
"oneOf": [
{
"$ref": "#/components/schemas/PluginTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"public_jobs": {
"nullable": true
},
"capabilities": {},
"config_schema": {},
"organization_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"organization_name": {
"type": "string",
"readOnly": true
}
}
}
PluginConfig
{
"type": "object",
"required": [
"config",
"created_at",
"delivery_rate_24h",
"error",
"id",
"order",
"plugin",
"plugin_info",
"team_id",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"error": {
"type": "string",
"readOnly": true
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"config": {
"type": "string",
"readOnly": true
},
"plugin": {
"type": "integer"
},
"deleted": {
"type": "boolean",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"team_id": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 1000
},
"plugin_info": {
"type": "string",
"readOnly": true
},
"delivery_rate_24h": {
"type": "string",
"readOnly": true
}
}
}
PluginLogEntry
{
"type": "object",
"required": [
"id",
"instance_id",
"message",
"plugin_config_id",
"plugin_id",
"source",
"team_id",
"timestamp",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"type": {
"$ref": "#/components/schemas/PluginLogEntryTypeEnum"
},
"source": {
"$ref": "#/components/schemas/SourceEnum"
},
"message": {
"type": "string"
},
"team_id": {
"type": "integer"
},
"plugin_id": {
"type": "integer"
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"instance_id": {
"type": "string",
"format": "uuid"
},
"plugin_config_id": {
"type": "integer"
}
}
}
PluginLogEntryTypeEnum
{
"enum": [
"DEBUG",
"LOG",
"INFO",
"WARN",
"ERROR"
],
"type": "string",
"description": "* `DEBUG` - DEBUG\n* `LOG` - LOG\n* `INFO` - INFO\n* `WARN` - WARN\n* `ERROR` - ERROR"
}
PluginTypeEnum
{
"enum": [
"local",
"custom",
"repository",
"source"
],
"type": "string",
"description": "* `local` - local\n* `custom` - custom\n* `repository` - repository\n* `source` - source"
}
PluginsAccessLevelEnum
{
"enum": [
0,
3,
6,
9
],
"type": "integer",
"description": "* `0` - none\n* `3` - config\n* `6` - install\n* `9` - root"
}
Property
{
"type": "object",
"required": [
"values"
],
"properties": {
"type": {
"$ref": "#/components/schemas/PropertyTypeEnum"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyItem"
}
}
},
"x-konfig-properties": {
"type": {
"default": "AND",
"description": "\n You can use a simplified version:\n```json\n{\n \"properties\": [\n {\n \"key\": \"email\",\n \"value\": \"x@y.com\",\n \"operator\": \"exact\",\n \"type\": \"event\"\n }\n ]\n}\n```\n\nOr you can create more complicated queries with AND and OR:\n```json\n{\n \"properties\": {\n \"type\": \"AND\",\n \"values\": [\n {\n \"type\": \"OR\",\n \"values\": [\n {\"key\": \"email\", ...},\n {\"key\": \"email\", ...}\n ]\n },\n {\n \"type\": \"AND\",\n \"values\": [\n {\"key\": \"email\", ...},\n {\"key\": \"email\", ...}\n ]\n }\n ]\n ]\n}\n```\n\n\n* `AND` - AND\n* `OR` - OR"
}
}
}
PropertyGroupFilter
{
"type": "object",
"title": "PropertyGroupFilter",
"required": [
"type",
"values"
],
"properties": {
"type": {
"$ref": "#/components/schemas/FilterLogicalOperator"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyGroupFilterValue"
},
"title": "Values"
}
}
}
PropertyGroupFilterValue
{
"type": "object",
"title": "PropertyGroupFilterValue",
"required": [
"type",
"values"
],
"properties": {
"type": {
"$ref": "#/components/schemas/FilterLogicalOperator"
},
"values": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/PropertyGroupFilterValue"
},
{
"$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": "Values"
}
}
}
PropertyItem
{
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"description": "Key of the property you're filtering on. For example `email` or `$current_url`"
},
"type": {
"oneOf": [
{
"$ref": "#/components/schemas/PropertyItemTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
],
"default": "event"
},
"value": {
"type": "string",
"description": "Value of your filter. For example `test@example.com` or `https://example.com/test/`. Can be an array for an OR query, like `[\"test@example.com\",\"ok@example.com\"]`"
},
"operator": {
"oneOf": [
{
"$ref": "#/components/schemas/OperatorEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"default": "exact",
"nullable": true
}
}
}
PropertyItemTypeEnum
{
"enum": [
"event",
"feature",
"person",
"cohort",
"element",
"static-cohort",
"precalculated-cohort",
"group",
"recording",
"behavioral",
"session",
"hogql",
"data_warehouse",
"data_warehouse_person_property"
],
"type": "string",
"description": "* `event` - event\n* `feature` - feature\n* `person` - person\n* `cohort` - cohort\n* `element` - element\n* `static-cohort` - static-cohort\n* `precalculated-cohort` - precalculated-cohort\n* `group` - group\n* `recording` - recording\n* `behavioral` - behavioral\n* `session` - session\n* `hogql` - hogql\n* `data_warehouse` - data_warehouse\n* `data_warehouse_person_property` - data_warehouse_person_property"
}
PropertyMathType
{
"enum": [
"avg",
"sum",
"min",
"max",
"median",
"p90",
"p95",
"p99"
],
"type": "string",
"title": "PropertyMathType"
}
PropertyOperator
{
"enum": [
"exact",
"is_not",
"icontains",
"not_icontains",
"regex",
"not_regex",
"gt",
"gte",
"lt",
"lte",
"is_set",
"is_not_set",
"is_date_exact",
"is_date_before",
"is_date_after",
"between",
"not_between",
"min",
"max"
],
"type": "string",
"title": "PropertyOperator"
}
PropertyTypeEnum
{
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "* `AND` - AND\n* `OR` - OR"
}
QueryRequest
{
"type": "object",
"title": "QueryRequest",
"required": [
"query"
],
"properties": {
"async": {
"type": "boolean",
"title": "Async",
"default": null,
"example": true,
"nullable": true,
"x-examples": [
true
],
"description": "(Experimental) Whether to run the query asynchronously. Defaults to False. If True, the `id` of the query can be used to check the status and to cancel it."
},
"query": {
"oneOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/PersonsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
},
{
"$ref": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
{
"$ref": "#/components/schemas/EventsQuery"
},
{
"$ref": "#/components/schemas/ActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQuery"
},
{
"$ref": "#/components/schemas/InsightActorsQueryOptions"
},
{
"$ref": "#/components/schemas/SessionsTimelineQuery"
},
{
"$ref": "#/components/schemas/HogQLQuery"
},
{
"$ref": "#/components/schemas/HogQLMetadata"
},
{
"$ref": "#/components/schemas/HogQLAutocomplete"
},
{
"$ref": "#/components/schemas/WebOverviewQuery"
},
{
"$ref": "#/components/schemas/WebStatsTableQuery"
},
{
"$ref": "#/components/schemas/WebTopClicksQuery"
},
{
"$ref": "#/components/schemas/DataVisualizationNode"
},
{
"$ref": "#/components/schemas/DataTableNode"
},
{
"$ref": "#/components/schemas/SavedInsightNode"
},
{
"$ref": "#/components/schemas/InsightVizNode"
},
{
"$ref": "#/components/schemas/TrendsQuery"
},
{
"$ref": "#/components/schemas/FunnelsQuery"
},
{
"$ref": "#/components/schemas/RetentionQuery"
},
{
"$ref": "#/components/schemas/PathsQuery"
},
{
"$ref": "#/components/schemas/StickinessQuery"
},
{
"$ref": "#/components/schemas/LifecycleQuery"
},
{
"$ref": "#/components/schemas/FunnelCorrelationQuery"
},
{
"$ref": "#/components/schemas/DatabaseSchemaQuery"
}
],
"title": "Query",
"description": "Submit a JSON string representing a query for PostHog data analysis, for example a HogQL query.\n\nExample payload:\n\n```\n\n{\"query\": {\"kind\": \"HogQLQuery\", \"query\": \"select * from events limit 100\"}}\n\n```\n\nFor more details on HogQL queries, see the [PostHog HogQL documentation](/docs/hogql#api-access).",
"discriminator": {
"mapping": {
"EventsNode": "#/components/schemas/EventsNode",
"HogQLQuery": "#/components/schemas/HogQLQuery",
"PathsQuery": "#/components/schemas/PathsQuery",
"ActionsNode": "#/components/schemas/ActionsNode",
"ActorsQuery": "#/components/schemas/ActorsQuery",
"EventsQuery": "#/components/schemas/EventsQuery",
"PersonsNode": "#/components/schemas/PersonsNode",
"TrendsQuery": "#/components/schemas/TrendsQuery",
"FunnelsQuery": "#/components/schemas/FunnelsQuery",
"DataTableNode": "#/components/schemas/DataTableNode",
"HogQLMetadata": "#/components/schemas/HogQLMetadata",
"InsightVizNode": "#/components/schemas/InsightVizNode",
"LifecycleQuery": "#/components/schemas/LifecycleQuery",
"RetentionQuery": "#/components/schemas/RetentionQuery",
"StickinessQuery": "#/components/schemas/StickinessQuery",
"SavedInsightNode": "#/components/schemas/SavedInsightNode",
"WebOverviewQuery": "#/components/schemas/WebOverviewQuery",
"DataWarehouseNode": "#/components/schemas/DataWarehouseNode",
"HogQLAutocomplete": "#/components/schemas/HogQLAutocomplete",
"WebTopClicksQuery": "#/components/schemas/WebTopClicksQuery",
"InsightActorsQuery": "#/components/schemas/InsightActorsQuery",
"WebStatsTableQuery": "#/components/schemas/WebStatsTableQuery",
"DatabaseSchemaQuery": "#/components/schemas/DatabaseSchemaQuery",
"DataVisualizationNode": "#/components/schemas/DataVisualizationNode",
"SessionsTimelineQuery": "#/components/schemas/SessionsTimelineQuery",
"FunnelCorrelationQuery": "#/components/schemas/FunnelCorrelationQuery",
"InsightActorsQueryOptions": "#/components/schemas/InsightActorsQueryOptions",
"TimeToSeeDataSessionsQuery": "#/components/schemas/TimeToSeeDataSessionsQuery"
},
"propertyName": "kind"
}
},
"refresh": {
"type": "boolean",
"title": "Refresh",
"default": null,
"nullable": true
},
"client_query_id": {
"type": "string",
"title": "Client Query Id",
"default": null,
"nullable": true,
"description": "Client provided query ID. Can be used to retrieve the status or cancel the query."
}
}
}
QueryResponseAlternative
{
"anyOf": [
{
"$ref": "#/components/schemas/QueryResponseAlternative1"
},
{
"type": "object"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative2"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative3"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative4"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative5"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative6"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative7"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative8"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative9"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative10"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative11"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative12"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative13"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative14"
},
{
"$ref": "#/components/schemas/QueryResponseAlternative17"
},
{
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DatabaseSchemaQueryResponseField"
}
}
}
],
"title": "QueryResponseAlternative"
}
QueryResponseAlternative1
{
"type": "object",
"title": "QueryResponseAlternative1",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"title": "Next",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventType"
},
"title": "Results"
}
}
}
QueryResponseAlternative10
{
"type": "object",
"title": "QueryResponseAlternative10",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebOverviewItem"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative11
{
"type": "object",
"title": "QueryResponseAlternative11",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative12
{
"type": "object",
"title": "QueryResponseAlternative12",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative13
{
"type": "object",
"title": "QueryResponseAlternative13",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative14
{
"type": "object",
"title": "QueryResponseAlternative14",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionResult"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative17
{
"type": "object",
"title": "QueryResponseAlternative17",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"$ref": "#/components/schemas/FunnelCorrelationResult"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative2
{
"type": "object",
"title": "QueryResponseAlternative2",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
}
}
}
QueryResponseAlternative3
{
"type": "object",
"title": "QueryResponseAlternative3",
"required": [
"columns",
"hogql",
"results",
"types"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"title": "Types"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"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
}
}
}
QueryResponseAlternative4
{
"type": "object",
"title": "QueryResponseAlternative4",
"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
}
}
}
QueryResponseAlternative5
{
"type": "object",
"title": "QueryResponseAlternative5",
"properties": {
"day": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayItem"
},
"title": "Day",
"default": null,
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"title": "Series",
"default": null,
"nullable": true
},
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusItem"
},
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareItem"
},
"title": "Compare",
"default": null,
"nullable": true
},
"interval": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntervalItem"
},
"title": "Interval",
"default": null,
"nullable": true
},
"breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
},
"title": "Breakdown",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative6
{
"type": "object",
"title": "QueryResponseAlternative6",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEntry"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative7
{
"type": "object",
"title": "QueryResponseAlternative7",
"properties": {
"error": {
"type": "string",
"title": "Error",
"default": null,
"nullable": true,
"description": "Query error. Returned only if 'explain' is true. Throws an error otherwise."
},
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true,
"description": "Generated HogQL query"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"query": {
"type": "string",
"title": "Query",
"default": null,
"nullable": true,
"description": "Input query string"
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true,
"description": "Types of returned columns"
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true,
"description": "Returned columns"
},
"explain": {
"type": "array",
"items": {
"type": "string"
},
"title": "Explain",
"default": null,
"nullable": true,
"description": "Query explanation output"
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results",
"default": null,
"nullable": true,
"description": "Query results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"metadata": {
"$ref": "#/components/schemas/HogQLMetadataResponseNullable"
},
"modifiers": {
"$ref": "#/components/schemas/HogQLQueryModifiersNullable"
},
"clickhouse": {
"type": "string",
"title": "Clickhouse",
"default": null,
"nullable": true,
"description": "Executed ClickHouse query"
}
}
}
QueryResponseAlternative8
{
"type": "object",
"title": "QueryResponseAlternative8",
"required": [
"errors",
"notices",
"warnings"
],
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Errors"
},
"isValid": {
"type": "boolean",
"title": "Isvalid",
"default": null,
"nullable": true
},
"notices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Notices"
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HogQLNotice"
},
"title": "Warnings"
},
"inputExpr": {
"type": "string",
"title": "Inputexpr",
"default": null,
"nullable": true
},
"inputSelect": {
"type": "string",
"title": "Inputselect",
"default": null,
"nullable": true
},
"isValidView": {
"type": "boolean",
"title": "Isvalidview",
"default": null,
"nullable": true
}
}
}
QueryResponseAlternative9
{
"type": "object",
"title": "QueryResponseAlternative9",
"required": [
"incomplete_list",
"suggestions"
],
"properties": {
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true,
"description": "Measured timings for different parts of the query generation process"
},
"suggestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutocompleteCompletionItem"
},
"title": "Suggestions"
},
"incomplete_list": {
"type": "boolean",
"title": "Incomplete List",
"description": "Whether or not the suggestions returned are complete"
}
}
}
QueryTiming
{
"type": "object",
"title": "QueryTiming",
"required": [
"k",
"t"
],
"properties": {
"k": {
"type": "string",
"title": "K",
"description": "Key. Shortened to 'k' to save on data."
},
"t": {
"type": "number",
"title": "T",
"description": "Time in seconds. Shortened to 't' to save on data."
}
}
}
RecordingDurationFilter
{
"type": "object",
"title": "RecordingDurationFilter",
"required": [
"operator",
"value"
],
"properties": {
"key": {
"const": "duration",
"title": "Key",
"default": "duration"
},
"type": {
"const": "recording",
"title": "Type",
"default": "recording"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"type": "number",
"title": "Value"
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
Response
{
"type": "object",
"title": "Response",
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"title": "Next",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventType"
},
"title": "Results"
}
}
}
ResponseNullable
{
"type": "object",
"title": "Response",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"next": {
"type": "string",
"title": "Next",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventType"
},
"title": "Results"
}
},
"description": "Return a limited set of data"
}
RestrictionLevelEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Everyone in the project can edit\n* `37` - Only those invited to this dashboard can edit"
}
RetentionEntity
{
"type": "object",
"title": "RetentionEntity",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"title": "Id",
"default": null,
"nullable": true
},
"kind": {
"$ref": "#/components/schemas/Kind1Nullable"
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EntityTypeNullable"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"order": {
"type": "integer",
"title": "Order",
"default": null,
"nullable": true
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
}
}
}
RetentionEntityNullable
{
"type": "object",
"title": "RetentionEntity",
"default": null,
"nullable": true,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"title": "Id",
"default": null,
"nullable": true
},
"kind": {
"$ref": "#/components/schemas/Kind1Nullable"
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EntityTypeNullable"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"order": {
"type": "integer",
"title": "Order",
"default": null,
"nullable": true
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
}
}
}
RetentionFilter
{
"type": "object",
"title": "RetentionFilter",
"properties": {
"period": {
"$ref": "#/components/schemas/RetentionPeriodNullable"
},
"targetEntity": {
"$ref": "#/components/schemas/RetentionEntityNullable"
},
"retentionType": {
"$ref": "#/components/schemas/RetentionTypeNullable"
},
"totalIntervals": {
"type": "integer",
"title": "Totalintervals",
"default": null,
"nullable": true
},
"returningEntity": {
"$ref": "#/components/schemas/RetentionEntityNullable"
},
"retentionReference": {
"$ref": "#/components/schemas/RetentionReferenceNullable"
}
}
}
RetentionPeriod
{
"enum": [
"Hour",
"Day",
"Week",
"Month"
],
"type": "string",
"title": "RetentionPeriod"
}
RetentionPeriodNullable
{
"enum": [
"Hour",
"Day",
"Week",
"Month"
],
"type": "string",
"title": "RetentionPeriod",
"default": null,
"nullable": true
}
RetentionQuery
{
"type": "object",
"title": "RetentionQuery",
"required": [
"retentionFilter"
],
"properties": {
"kind": {
"const": "RetentionQuery",
"title": "Kind",
"default": "RetentionQuery"
},
"response": {
"$ref": "#/components/schemas/RetentionQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"retentionFilter": {
"$ref": "#/components/schemas/RetentionFilter"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
},
"x-konfig-properties": {
"retentionFilter": {
"description": "Properties specific to the retention insight"
}
}
}
RetentionQueryResponse
{
"type": "object",
"title": "RetentionQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionResult"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
RetentionQueryResponseNullable
{
"type": "object",
"title": "RetentionQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionResult"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
RetentionReference
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "RetentionReference"
}
RetentionReferenceNullable
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "RetentionReference",
"default": null,
"nullable": true
}
RetentionResult
{
"type": "object",
"title": "RetentionResult",
"required": [
"date",
"label",
"values"
],
"properties": {
"date": {
"type": "string",
"title": "Date",
"format": "date-time"
},
"label": {
"type": "string",
"title": "Label"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionValue"
},
"title": "Values"
}
}
}
RetentionType
{
"enum": [
"retention_recurring",
"retention_first_time"
],
"type": "string",
"title": "RetentionType"
}
RetentionTypeNullable
{
"enum": [
"retention_recurring",
"retention_first_time"
],
"type": "string",
"title": "RetentionType",
"default": null,
"nullable": true
}
RetentionValue
{
"type": "object",
"title": "RetentionValue",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"title": "Count"
}
}
}
Role
{
"type": "object",
"required": [
"associated_flags",
"created_at",
"created_by",
"id",
"members",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"members": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"associated_flags": {
"type": "string",
"readOnly": true
},
"feature_flags_access_level": {
"$ref": "#/components/schemas/FeatureFlagsAccessLevelEnum"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flags_access_level": {
"maximum": 32767,
"minimum": 0
}
}
}
RoleMembership
{
"type": "object",
"required": [
"id",
"joined_at",
"organization_member",
"role_id",
"updated_at",
"user",
"user_uuid"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"role_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"joined_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
},
"organization_member": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"organization_member": {
"readOnly": true
}
}
}
Sampling
{
"type": "object",
"title": "Sampling",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": null,
"nullable": true
},
"forceSamplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
}
}
}
SamplingNullable
{
"type": "object",
"title": "Sampling",
"default": null,
"nullable": true,
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": null,
"nullable": true
},
"forceSamplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
}
}
}
SamplingRate
{
"type": "object",
"title": "SamplingRate",
"required": [
"numerator"
],
"properties": {
"numerator": {
"type": "number",
"title": "Numerator"
},
"denominator": {
"type": "number",
"title": "Denominator",
"default": null,
"nullable": true
}
}
}
SamplingRateNullable
{
"type": "object",
"title": "SamplingRate",
"default": null,
"nullable": true,
"required": [
"numerator"
],
"properties": {
"numerator": {
"type": "number",
"title": "Numerator"
},
"denominator": {
"type": "number",
"title": "Denominator",
"default": null,
"nullable": true
}
}
}
SavedInsightNode
{
"type": "object",
"title": "SavedInsightNode",
"required": [
"shortId"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in insight scene."
},
"kind": {
"const": "SavedInsightNode",
"title": "Kind",
"default": "SavedInsightNode"
},
"shortId": {
"type": "string",
"title": "Shortid"
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Query is embedded inside another bordered component"
},
"showTable": {
"type": "boolean",
"title": "Showtable",
"default": null,
"nullable": true
},
"expandable": {
"type": "boolean",
"title": "Expandable",
"default": null,
"nullable": true,
"description": "Can expand row to show raw event data (default: true)"
},
"showExport": {
"type": "boolean",
"title": "Showexport",
"default": null,
"nullable": true,
"description": "Show the export button"
},
"showHeader": {
"type": "boolean",
"title": "Showheader",
"default": null,
"nullable": true
},
"showReload": {
"type": "boolean",
"title": "Showreload",
"default": null,
"nullable": true,
"description": "Show a reload button"
},
"showSearch": {
"type": "boolean",
"title": "Showsearch",
"default": null,
"nullable": true,
"description": "Include a free text search field (PersonsNode only)"
},
"showActions": {
"type": "boolean",
"title": "Showactions",
"default": null,
"nullable": true,
"description": "Show the kebab menu at the end of the row"
},
"showFilters": {
"type": "boolean",
"title": "Showfilters",
"default": null,
"nullable": true
},
"showResults": {
"type": "boolean",
"title": "Showresults",
"default": null,
"nullable": true
},
"showTimings": {
"type": "boolean",
"title": "Showtimings",
"default": null,
"nullable": true,
"description": "Show a detailed query timing breakdown"
},
"allowSorting": {
"type": "boolean",
"title": "Allowsorting",
"default": null,
"nullable": true,
"description": "Can the user click on column headers to sort the table? (default: true)"
},
"showDateRange": {
"type": "boolean",
"title": "Showdaterange",
"default": null,
"nullable": true,
"description": "Show date range selector"
},
"showElapsedTime": {
"type": "boolean",
"title": "Showelapsedtime",
"default": null,
"nullable": true,
"description": "Show the time it takes to run a query"
},
"showEventFilter": {
"type": "boolean",
"title": "Showeventfilter",
"default": null,
"nullable": true,
"description": "Include an event filter above the table (EventsNode only)"
},
"showHogQLEditor": {
"type": "boolean",
"title": "Showhogqleditor",
"default": null,
"nullable": true,
"description": "Include a HogQL query editor above HogQL tables"
},
"hidePersonsModal": {
"type": "boolean",
"title": "Hidepersonsmodal",
"default": null,
"nullable": true
},
"propertiesViaUrl": {
"type": "boolean",
"title": "Propertiesviaurl",
"default": null,
"nullable": true,
"description": "Link properties via the URL (default: false)"
},
"showResultsTable": {
"type": "boolean",
"title": "Showresultstable",
"default": null,
"nullable": true,
"description": "Show a results table"
},
"showSavedQueries": {
"type": "boolean",
"title": "Showsavedqueries",
"default": null,
"nullable": true,
"description": "Shows a list of saved queries"
},
"showPropertyFilter": {
"type": "boolean",
"title": "Showpropertyfilter",
"default": null,
"nullable": true,
"description": "Include a property filter above the table"
},
"vizSpecificOptions": {
"$ref": "#/components/schemas/VizSpecificOptionsNullable"
},
"showLastComputation": {
"type": "boolean",
"title": "Showlastcomputation",
"default": null,
"nullable": true
},
"showCorrelationTable": {
"type": "boolean",
"title": "Showcorrelationtable",
"default": null,
"nullable": true
},
"showOpenEditorButton": {
"type": "boolean",
"title": "Showopeneditorbutton",
"default": null,
"nullable": true,
"description": "Show a button to open the current query as a new insight. (default: true)"
},
"showColumnConfigurator": {
"type": "boolean",
"title": "Showcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure the table's columns if possible"
},
"showTestAccountFilters": {
"type": "boolean",
"title": "Showtestaccountfilters",
"default": null,
"nullable": true,
"description": "Show filter to exclude test accounts"
},
"showLastComputationRefresh": {
"type": "boolean",
"title": "Showlastcomputationrefresh",
"default": null,
"nullable": true
},
"suppressSessionAnalysisWarning": {
"type": "boolean",
"title": "Suppresssessionanalysiswarning",
"default": null,
"nullable": true
},
"showPersistentColumnConfigurator": {
"type": "boolean",
"title": "Showpersistentcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure and persist the table's default columns if possible"
}
}
}
ScenePersonalisationBasic
{
"type": "object",
"required": [
"scene"
],
"properties": {
"scene": {
"type": "string",
"maxLength": 200
},
"dashboard": {
"type": "integer",
"nullable": true
}
}
}
Series
{
"type": "object",
"title": "Series",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "integer",
"title": "Value"
}
}
}
SessionPropertyFilter
{
"type": "object",
"title": "SessionPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "session",
"title": "Type",
"default": "session"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
SessionRecording
{
"type": "object",
"required": [
"active_seconds",
"click_count",
"console_error_count",
"console_log_count",
"console_warn_count",
"distinct_id",
"end_time",
"id",
"inactive_seconds",
"keypress_count",
"mouse_activity_count",
"recording_duration",
"start_time",
"start_url",
"storage",
"viewed"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"person": {
"$ref": "#/components/schemas/MinimalPerson"
},
"viewed": {
"type": "string",
"readOnly": true
},
"storage": {
"type": "string",
"readOnly": true
},
"end_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"start_url": {
"type": "string",
"nullable": true,
"readOnly": true
},
"start_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"click_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"distinct_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active_seconds": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"keypress_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"inactive_seconds": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"console_log_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"console_warn_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"recording_duration": {
"type": "integer",
"readOnly": true
},
"console_error_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"mouse_activity_count": {
"type": "integer",
"nullable": true,
"readOnly": true
}
}
}
SessionRecordingPlaylist
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"last_modified_at",
"last_modified_by",
"short_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"pinned": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
SessionrecordingsGetSharingResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
SessionsTimelineQuery
{
"type": "object",
"title": "SessionsTimelineQuery",
"properties": {
"kind": {
"const": "SessionsTimelineQuery",
"title": "Kind",
"default": "SessionsTimelineQuery"
},
"after": {
"type": "string",
"title": "After",
"default": null,
"nullable": true,
"description": "Only fetch sessions that started after this timestamp (default: '-24h')"
},
"before": {
"type": "string",
"title": "Before",
"default": null,
"nullable": true,
"description": "Only fetch sessions that started before this timestamp (default: '+5s')"
},
"personId": {
"type": "string",
"title": "Personid",
"default": null,
"nullable": true,
"description": "Fetch sessions only for a given person"
},
"response": {
"$ref": "#/components/schemas/SessionsTimelineQueryResponseNullable"
}
}
}
SessionsTimelineQueryResponse
{
"type": "object",
"title": "SessionsTimelineQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEntry"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
SessionsTimelineQueryResponseNullable
{
"type": "object",
"title": "SessionsTimelineQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEntry"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
},
"description": "Cached query response"
}
SharingConfiguration
{
"type": "object",
"required": [
"access_token",
"created_at"
],
"properties": {
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"access_token": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
SourceEnum
{
"enum": [
"SYSTEM",
"PLUGIN",
"CONSOLE"
],
"type": "string",
"description": "* `SYSTEM` - SYSTEM\n* `PLUGIN` - PLUGIN\n* `CONSOLE` - CONSOLE"
}
StageEnum
{
"enum": [
"draft",
"concept",
"alpha",
"beta",
"general-availability",
"archived"
],
"type": "string",
"description": "* `draft` - draft\n* `concept` - concept\n* `alpha` - alpha\n* `beta` - beta\n* `general-availability` - general availability\n* `archived` - archived"
}
StatusEnum
{
"enum": [
"Cancelled",
"Completed",
"ContinuedAsNew",
"Failed",
"FailedRetryable",
"Terminated",
"TimedOut",
"Running",
"Starting"
],
"type": "string",
"description": "* `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"
}
StatusItem
{
"type": "object",
"title": "StatusItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "string",
"title": "Value"
}
}
}
StepOrderValue
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"title": "StepOrderValue"
}
StepOrderValueNullable
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"title": "StepOrderValue",
"default": null,
"nullable": true
}
StickinessFilter
{
"type": "object",
"title": "StickinessFilter",
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
}
}
}
StickinessFilterNullable
{
"type": "object",
"title": "StickinessFilter",
"default": null,
"nullable": true,
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the stickiness insight"
}
StickinessQuery
{
"type": "object",
"title": "StickinessQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "StickinessQuery",
"title": "Kind",
"default": "StickinessQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"stickinessFilter": {
"$ref": "#/components/schemas/StickinessFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
}
}
}
Subscription
{
"type": "object",
"required": [
"created_at",
"created_by",
"frequency",
"id",
"next_delivery_date",
"start_date",
"summary",
"target_type",
"target_value"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 100
},
"deleted": {
"type": "boolean"
},
"insight": {
"type": "integer",
"nullable": true
},
"summary": {
"type": "string",
"readOnly": true
},
"bysetpos": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"interval": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"byweekday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ByweekdayEnum"
},
"nullable": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"frequency": {
"$ref": "#/components/schemas/FrequencyEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"until_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"target_type": {
"$ref": "#/components/schemas/TargetTypeEnum"
},
"target_value": {
"type": "string"
},
"invite_message": {
"type": "string",
"nullable": true
},
"next_delivery_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
}
},
"description": "Standard Subscription serializer.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
Survey
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"linked_flag",
"name",
"targeting_flag",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
SurveySerializerCreateUpdateOnly
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"linked_flag",
"name",
"targeting_flag",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true,
"writeOnly": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"targeting_flag_id": {
"type": "integer",
"writeOnly": true
},
"remove_targeting_flag": {
"type": "boolean",
"nullable": true,
"writeOnly": true
},
"targeting_flag_filters": {
"nullable": true,
"writeOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
TargetTypeEnum
{
"enum": [
"email",
"slack",
"webhook"
],
"type": "string",
"description": "* `email` - Email\n* `slack` - Slack\n* `webhook` - Webhook"
}
Team
{
"type": "object",
"required": [
"api_token",
"created_at",
"effective_membership_level",
"groups_on_events_querying_enabled",
"has_group_types",
"id",
"ingested_event",
"organization",
"person_on_events_querying_enabled",
"updated_at",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean"
},
"app_urls": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"anonymize_ips": {
"type": "boolean"
},
"access_control": {
"type": "boolean"
},
"extra_settings": {
"nullable": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"surveys_opt_in": {
"type": "boolean",
"nullable": true
},
"week_start_day": {
"oneOf": [
{
"$ref": "#/components/schemas/WeekStartDayEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"maximum": 32767,
"minimum": -32768,
"nullable": true
},
"data_attributes": {},
"has_group_types": {
"type": "boolean",
"readOnly": true
},
"inject_web_apps": {
"type": "boolean",
"nullable": true
},
"primary_dashboard": {
"type": "integer",
"nullable": true
},
"recording_domains": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"nullable": true
},
"correlation_config": {
"nullable": true
},
"autocapture_opt_out": {
"type": "boolean",
"nullable": true
},
"live_events_columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"test_account_filters": {},
"path_cleaning_filters": {
"nullable": true
},
"session_replay_config": {
"nullable": true
},
"slack_incoming_webhook": {
"type": "string",
"nullable": true,
"maxLength": 500
},
"session_recording_opt_in": {
"type": "boolean"
},
"capture_console_log_opt_in": {
"type": "boolean",
"nullable": true
},
"capture_performance_opt_in": {
"type": "boolean",
"nullable": true
},
"effective_membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean"
},
"has_completed_onboarding_for": {
"nullable": true
},
"autocapture_exceptions_opt_in": {
"type": "boolean",
"nullable": true
},
"session_recording_linked_flag": {
"nullable": true
},
"session_recording_sample_rate": {
"type": "string",
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$",
"nullable": true
},
"person_display_name_properties": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400
},
"nullable": true
},
"groups_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"person_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"test_account_filters_default_checked": {
"type": "boolean",
"nullable": true
},
"autocapture_exceptions_errors_to_ignore": {
"nullable": true
},
"session_recording_minimum_duration_milliseconds": {
"type": "integer",
"maximum": 15000,
"minimum": 0,
"nullable": true
},
"session_recording_network_payload_capture_config": {
"nullable": true
}
}
}
TeamBasic
{
"type": "object",
"required": [
"access_control",
"api_token",
"completed_snippet_onboarding",
"has_completed_onboarding_for",
"id",
"ingested_event",
"is_demo",
"name",
"organization",
"timezone",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean",
"readOnly": true
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"access_control": {
"type": "boolean",
"readOnly": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean",
"readOnly": true
},
"has_completed_onboarding_for": {
"nullable": true,
"readOnly": true
}
},
"description": "Serializer for `Team` model with minimal attributes to speeed up loading and transfer times.\nAlso used for nested serializers.",
"x-konfig-properties": {
"timezone": {
"readOnly": true
}
}
}
ThemeModeEnum
{
"enum": [
"light",
"dark",
"system"
],
"type": "string",
"description": "* `light` - Light\n* `dark` - Dark\n* `system` - System"
}
TimeToSeeDataSessionsQuery
{
"type": "object",
"title": "TimeToSeeDataSessionsQuery",
"properties": {
"kind": {
"const": "TimeToSeeDataSessionsQuery",
"title": "Kind",
"default": "TimeToSeeDataSessionsQuery"
},
"teamId": {
"type": "integer",
"title": "Teamid",
"default": null,
"nullable": true,
"description": "Project to filter on. Defaults to current project"
},
"response": {
"$ref": "#/components/schemas/TimeToSeeDataSessionsQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
}
}
}
TimeToSeeDataSessionsQueryResponse
{
"type": "object",
"title": "TimeToSeeDataSessionsQueryResponse",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
}
}
}
TimeToSeeDataSessionsQueryResponseNullable
{
"type": "object",
"title": "TimeToSeeDataSessionsQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
}
},
"description": "Cached query response"
}
TimelineEntry
{
"type": "object",
"title": "TimelineEntry",
"required": [
"events"
],
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventType"
},
"title": "Events"
},
"sessionId": {
"type": "string",
"title": "Sessionid",
"default": null,
"nullable": true,
"description": "Session ID. None means out-of-session events"
},
"recording_duration_s": {
"type": "number",
"title": "Recording Duration S",
"default": null,
"nullable": true,
"description": "Duration of the recording in seconds."
}
}
}
TimezoneEnum
{
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/ComodRivadavia",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Atka",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Buenos_Aires",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Ensenada",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Jujuy",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Knox_IN",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Louisville",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montreal",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Acre",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Rosario",
"America/Santa_Isabel",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Shiprock",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Virgin",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/South_Pole",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Ashkhabad",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Calcutta",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Colombo",
"Asia/Dacca",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Harbin",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kashgar",
"Asia/Kathmandu",
"Asia/Katmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macao",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Saigon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Tel_Aviv",
"Asia/Thimbu",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ujung_Pandang",
"Asia/Ulaanbaatar",
"Asia/Ulan_Bator",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faeroe",
"Atlantic/Faroe",
"Atlantic/Jan_Mayen",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/ACT",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Canberra",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/LHI",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/NSW",
"Australia/North",
"Australia/Perth",
"Australia/Queensland",
"Australia/South",
"Australia/Sydney",
"Australia/Tasmania",
"Australia/Victoria",
"Australia/West",
"Australia/Yancowinna",
"Brazil/Acre",
"Brazil/DeNoronha",
"Brazil/East",
"Brazil/West",
"CET",
"CST6CDT",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Canada/Saskatchewan",
"Canada/Yukon",
"Chile/Continental",
"Chile/EasterIsland",
"Cuba",
"EET",
"EST",
"EST5EDT",
"Egypt",
"Eire",
"Etc/GMT",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT-0",
"Etc/GMT-1",
"Etc/GMT-10",
"Etc/GMT-11",
"Etc/GMT-12",
"Etc/GMT-13",
"Etc/GMT-14",
"Etc/GMT-2",
"Etc/GMT-3",
"Etc/GMT-4",
"Etc/GMT-5",
"Etc/GMT-6",
"Etc/GMT-7",
"Etc/GMT-8",
"Etc/GMT-9",
"Etc/GMT0",
"Etc/Greenwich",
"Etc/UCT",
"Etc/UTC",
"Etc/Universal",
"Etc/Zulu",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belfast",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Nicosia",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Tiraspol",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GB",
"GB-Eire",
"GMT",
"GMT+0",
"GMT-0",
"GMT0",
"Greenwich",
"HST",
"Hongkong",
"Iceland",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Iran",
"Israel",
"Jamaica",
"Japan",
"Kwajalein",
"Libya",
"MET",
"MST",
"MST7MDT",
"Mexico/BajaNorte",
"Mexico/BajaSur",
"Mexico/General",
"NZ",
"NZ-CHAT",
"Navajo",
"PRC",
"PST8PDT",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Ponape",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Samoa",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Truk",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Yap",
"Poland",
"Portugal",
"ROC",
"ROK",
"Singapore",
"Turkey",
"UCT",
"US/Alaska",
"US/Aleutian",
"US/Arizona",
"US/Central",
"US/East-Indiana",
"US/Eastern",
"US/Hawaii",
"US/Indiana-Starke",
"US/Michigan",
"US/Mountain",
"US/Pacific",
"US/Samoa",
"UTC",
"Universal",
"W-SU",
"WET",
"Zulu"
],
"type": "string",
"description": "* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Brazil/Acre` - Brazil/Acre\n* `Brazil/DeNoronha` - Brazil/DeNoronha\n* `Brazil/East` - Brazil/East\n* `Brazil/West` - Brazil/West\n* `CET` - CET\n* `CST6CDT` - CST6CDT\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Chile/Continental` - Chile/Continental\n* `Chile/EasterIsland` - Chile/EasterIsland\n* `Cuba` - Cuba\n* `EET` - EET\n* `EST` - EST\n* `EST5EDT` - EST5EDT\n* `Egypt` - Egypt\n* `Eire` - Eire\n* `Etc/GMT` - Etc/GMT\n* `Etc/GMT+0` - Etc/GMT+0\n* `Etc/GMT+1` - Etc/GMT+1\n* `Etc/GMT+10` - Etc/GMT+10\n* `Etc/GMT+11` - Etc/GMT+11\n* `Etc/GMT+12` - Etc/GMT+12\n* `Etc/GMT+2` - Etc/GMT+2\n* `Etc/GMT+3` - Etc/GMT+3\n* `Etc/GMT+4` - Etc/GMT+4\n* `Etc/GMT+5` - Etc/GMT+5\n* `Etc/GMT+6` - Etc/GMT+6\n* `Etc/GMT+7` - Etc/GMT+7\n* `Etc/GMT+8` - Etc/GMT+8\n* `Etc/GMT+9` - Etc/GMT+9\n* `Etc/GMT-0` - Etc/GMT-0\n* `Etc/GMT-1` - Etc/GMT-1\n* `Etc/GMT-10` - Etc/GMT-10\n* `Etc/GMT-11` - Etc/GMT-11\n* `Etc/GMT-12` - Etc/GMT-12\n* `Etc/GMT-13` - Etc/GMT-13\n* `Etc/GMT-14` - Etc/GMT-14\n* `Etc/GMT-2` - Etc/GMT-2\n* `Etc/GMT-3` - Etc/GMT-3\n* `Etc/GMT-4` - Etc/GMT-4\n* `Etc/GMT-5` - Etc/GMT-5\n* `Etc/GMT-6` - Etc/GMT-6\n* `Etc/GMT-7` - Etc/GMT-7\n* `Etc/GMT-8` - Etc/GMT-8\n* `Etc/GMT-9` - Etc/GMT-9\n* `Etc/GMT0` - Etc/GMT0\n* `Etc/Greenwich` - Etc/Greenwich\n* `Etc/UCT` - Etc/UCT\n* `Etc/UTC` - Etc/UTC\n* `Etc/Universal` - Etc/Universal\n* `Etc/Zulu` - Etc/Zulu\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GB` - GB\n* `GB-Eire` - GB-Eire\n* `GMT` - GMT\n* `GMT+0` - GMT+0\n* `GMT-0` - GMT-0\n* `GMT0` - GMT0\n* `Greenwich` - Greenwich\n* `HST` - HST\n* `Hongkong` - Hongkong\n* `Iceland` - Iceland\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Iran` - Iran\n* `Israel` - Israel\n* `Jamaica` - Jamaica\n* `Japan` - Japan\n* `Kwajalein` - Kwajalein\n* `Libya` - Libya\n* `MET` - MET\n* `MST` - MST\n* `MST7MDT` - MST7MDT\n* `Mexico/BajaNorte` - Mexico/BajaNorte\n* `Mexico/BajaSur` - Mexico/BajaSur\n* `Mexico/General` - Mexico/General\n* `NZ` - NZ\n* `NZ-CHAT` - NZ-CHAT\n* `Navajo` - Navajo\n* `PRC` - PRC\n* `PST8PDT` - PST8PDT\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `Poland` - Poland\n* `Portugal` - Portugal\n* `ROC` - ROC\n* `ROK` - ROK\n* `Singapore` - Singapore\n* `Turkey` - Turkey\n* `UCT` - UCT\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC\n* `Universal` - Universal\n* `W-SU` - W-SU\n* `WET` - WET\n* `Zulu` - Zulu"
}
ToolbarModeEnum
{
"enum": [
"disabled",
"toolbar"
],
"type": "string",
"description": "* `disabled` - disabled\n* `toolbar` - toolbar"
}
Trend
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterEvent"
},
"description": "Events to filter on. One of `events` or `actions` is required."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterAction"
},
"description": "Actions to filter on. One of `events` or `actions` is required."
},
"compare": {
"type": "boolean",
"description": "For each returned result show the current period and the previous period. The result will contain `compare:true` and a `compare_label` with either `current` or `previous`."
},
"date_to": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results to. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"display": {
"$ref": "#/components/schemas/DisplayEnum"
},
"formula": {
"type": "string",
"description": "Combine the result of events or actions into a single number. For example `A + B` or `(A-B)/B`. The letters correspond to the order of the `events` or `actions` lists."
},
"breakdown": {
"type": "string",
"description": "A property or cohort to break down on. You can select the type of the property with breakdown_type.\n- `event` (default): a property key\n- `person`: a person property key\n- `cohort`: an array of cohort IDs (ie `[9581,5812]`)"
},
"date_from": {
"type": "string",
"default": "-7d",
"description": "What date to filter the results from. Can either be a date `2021-01-01`, or a relative date, like `-7d` for last seven days, `-1m` for last month, `mStart` for start of the month or `yStart` for the start of the year."
},
"properties": {
"$ref": "#/components/schemas/Property"
},
"breakdown_type": {
"$ref": "#/components/schemas/BreakdownTypeEnum"
},
"filter_test_accounts": {
"type": "boolean",
"default": false,
"description": "Whether to filter out internal and test accounts. See \"project settings\" in your PostHog account for the filters."
}
},
"x-konfig-properties": {
"display": {
"default": "ActionsLineGraph",
"description": "How to display the data. Will change how the data is returned.\n\n* `ActionsLineGraph` - ActionsLineGraph\n* `ActionsLineGraphCumulative` - ActionsLineGraphCumulative\n* `ActionsTable` - ActionsTable\n* `ActionsPie` - ActionsPie\n* `ActionsBar` - ActionsBar\n* `ActionsBarValue` - ActionsBarValue\n* `WorldMap` - WorldMap\n* `BoldNumber` - BoldNumber"
},
"properties": {
"description": "Filter events by event property, person property, cohort, groups and more."
},
"breakdown_type": {
"default": "event",
"description": "Type of property to break down on.\n\n* `event` - event\n* `person` - person\n* `cohort` - cohort\n* `group` - group\n* `session` - session\n* `hogql` - hogql"
}
}
}
TrendResult
{
"type": "object",
"required": [
"data",
"days",
"filter",
"label",
"labels"
],
"properties": {
"data": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The requested counts."
},
"days": {
"type": "array",
"items": {
"type": "string",
"format": "date"
},
"description": "The dates corresponding to the data field above."
},
"label": {
"type": "string",
"description": "A label describing this result. Will include\n- The event or action\n- Breakdown value\n- If `compare:true`, whether it's `current` or `previous`"
},
"filter": {
"$ref": "#/components/schemas/GenericInsights"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"description": "The dates corresponding to the data field above."
}
},
"x-konfig-properties": {
"filter": {
"description": "The insight that's being returned."
}
}
}
TrendResults
{
"type": "object",
"required": [
"is_cached",
"last_refresh",
"result"
],
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrendResult"
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"is_cached": {
"type": "boolean",
"description": "Whether the result is cached. To force a refresh, pass ?refresh=true"
},
"last_refresh": {
"type": "string",
"format": "date-time",
"description": "If the result is cached, when it was last refreshed."
}
},
"x-konfig-properties": {
"timezone": {
"default": "UTC",
"description": "Timezone the chart is displayed in\n\n* `Africa/Abidjan` - Africa/Abidjan\n* `Africa/Accra` - Africa/Accra\n* `Africa/Addis_Ababa` - Africa/Addis_Ababa\n* `Africa/Algiers` - Africa/Algiers\n* `Africa/Asmara` - Africa/Asmara\n* `Africa/Asmera` - Africa/Asmera\n* `Africa/Bamako` - Africa/Bamako\n* `Africa/Bangui` - Africa/Bangui\n* `Africa/Banjul` - Africa/Banjul\n* `Africa/Bissau` - Africa/Bissau\n* `Africa/Blantyre` - Africa/Blantyre\n* `Africa/Brazzaville` - Africa/Brazzaville\n* `Africa/Bujumbura` - Africa/Bujumbura\n* `Africa/Cairo` - Africa/Cairo\n* `Africa/Casablanca` - Africa/Casablanca\n* `Africa/Ceuta` - Africa/Ceuta\n* `Africa/Conakry` - Africa/Conakry\n* `Africa/Dakar` - Africa/Dakar\n* `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam\n* `Africa/Djibouti` - Africa/Djibouti\n* `Africa/Douala` - Africa/Douala\n* `Africa/El_Aaiun` - Africa/El_Aaiun\n* `Africa/Freetown` - Africa/Freetown\n* `Africa/Gaborone` - Africa/Gaborone\n* `Africa/Harare` - Africa/Harare\n* `Africa/Johannesburg` - Africa/Johannesburg\n* `Africa/Juba` - Africa/Juba\n* `Africa/Kampala` - Africa/Kampala\n* `Africa/Khartoum` - Africa/Khartoum\n* `Africa/Kigali` - Africa/Kigali\n* `Africa/Kinshasa` - Africa/Kinshasa\n* `Africa/Lagos` - Africa/Lagos\n* `Africa/Libreville` - Africa/Libreville\n* `Africa/Lome` - Africa/Lome\n* `Africa/Luanda` - Africa/Luanda\n* `Africa/Lubumbashi` - Africa/Lubumbashi\n* `Africa/Lusaka` - Africa/Lusaka\n* `Africa/Malabo` - Africa/Malabo\n* `Africa/Maputo` - Africa/Maputo\n* `Africa/Maseru` - Africa/Maseru\n* `Africa/Mbabane` - Africa/Mbabane\n* `Africa/Mogadishu` - Africa/Mogadishu\n* `Africa/Monrovia` - Africa/Monrovia\n* `Africa/Nairobi` - Africa/Nairobi\n* `Africa/Ndjamena` - Africa/Ndjamena\n* `Africa/Niamey` - Africa/Niamey\n* `Africa/Nouakchott` - Africa/Nouakchott\n* `Africa/Ouagadougou` - Africa/Ouagadougou\n* `Africa/Porto-Novo` - Africa/Porto-Novo\n* `Africa/Sao_Tome` - Africa/Sao_Tome\n* `Africa/Timbuktu` - Africa/Timbuktu\n* `Africa/Tripoli` - Africa/Tripoli\n* `Africa/Tunis` - Africa/Tunis\n* `Africa/Windhoek` - Africa/Windhoek\n* `America/Adak` - America/Adak\n* `America/Anchorage` - America/Anchorage\n* `America/Anguilla` - America/Anguilla\n* `America/Antigua` - America/Antigua\n* `America/Araguaina` - America/Araguaina\n* `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires\n* `America/Argentina/Catamarca` - America/Argentina/Catamarca\n* `America/Argentina/ComodRivadavia` - America/Argentina/ComodRivadavia\n* `America/Argentina/Cordoba` - America/Argentina/Cordoba\n* `America/Argentina/Jujuy` - America/Argentina/Jujuy\n* `America/Argentina/La_Rioja` - America/Argentina/La_Rioja\n* `America/Argentina/Mendoza` - America/Argentina/Mendoza\n* `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos\n* `America/Argentina/Salta` - America/Argentina/Salta\n* `America/Argentina/San_Juan` - America/Argentina/San_Juan\n* `America/Argentina/San_Luis` - America/Argentina/San_Luis\n* `America/Argentina/Tucuman` - America/Argentina/Tucuman\n* `America/Argentina/Ushuaia` - America/Argentina/Ushuaia\n* `America/Aruba` - America/Aruba\n* `America/Asuncion` - America/Asuncion\n* `America/Atikokan` - America/Atikokan\n* `America/Atka` - America/Atka\n* `America/Bahia` - America/Bahia\n* `America/Bahia_Banderas` - America/Bahia_Banderas\n* `America/Barbados` - America/Barbados\n* `America/Belem` - America/Belem\n* `America/Belize` - America/Belize\n* `America/Blanc-Sablon` - America/Blanc-Sablon\n* `America/Boa_Vista` - America/Boa_Vista\n* `America/Bogota` - America/Bogota\n* `America/Boise` - America/Boise\n* `America/Buenos_Aires` - America/Buenos_Aires\n* `America/Cambridge_Bay` - America/Cambridge_Bay\n* `America/Campo_Grande` - America/Campo_Grande\n* `America/Cancun` - America/Cancun\n* `America/Caracas` - America/Caracas\n* `America/Catamarca` - America/Catamarca\n* `America/Cayenne` - America/Cayenne\n* `America/Cayman` - America/Cayman\n* `America/Chicago` - America/Chicago\n* `America/Chihuahua` - America/Chihuahua\n* `America/Ciudad_Juarez` - America/Ciudad_Juarez\n* `America/Coral_Harbour` - America/Coral_Harbour\n* `America/Cordoba` - America/Cordoba\n* `America/Costa_Rica` - America/Costa_Rica\n* `America/Creston` - America/Creston\n* `America/Cuiaba` - America/Cuiaba\n* `America/Curacao` - America/Curacao\n* `America/Danmarkshavn` - America/Danmarkshavn\n* `America/Dawson` - America/Dawson\n* `America/Dawson_Creek` - America/Dawson_Creek\n* `America/Denver` - America/Denver\n* `America/Detroit` - America/Detroit\n* `America/Dominica` - America/Dominica\n* `America/Edmonton` - America/Edmonton\n* `America/Eirunepe` - America/Eirunepe\n* `America/El_Salvador` - America/El_Salvador\n* `America/Ensenada` - America/Ensenada\n* `America/Fort_Nelson` - America/Fort_Nelson\n* `America/Fort_Wayne` - America/Fort_Wayne\n* `America/Fortaleza` - America/Fortaleza\n* `America/Glace_Bay` - America/Glace_Bay\n* `America/Godthab` - America/Godthab\n* `America/Goose_Bay` - America/Goose_Bay\n* `America/Grand_Turk` - America/Grand_Turk\n* `America/Grenada` - America/Grenada\n* `America/Guadeloupe` - America/Guadeloupe\n* `America/Guatemala` - America/Guatemala\n* `America/Guayaquil` - America/Guayaquil\n* `America/Guyana` - America/Guyana\n* `America/Halifax` - America/Halifax\n* `America/Havana` - America/Havana\n* `America/Hermosillo` - America/Hermosillo\n* `America/Indiana/Indianapolis` - America/Indiana/Indianapolis\n* `America/Indiana/Knox` - America/Indiana/Knox\n* `America/Indiana/Marengo` - America/Indiana/Marengo\n* `America/Indiana/Petersburg` - America/Indiana/Petersburg\n* `America/Indiana/Tell_City` - America/Indiana/Tell_City\n* `America/Indiana/Vevay` - America/Indiana/Vevay\n* `America/Indiana/Vincennes` - America/Indiana/Vincennes\n* `America/Indiana/Winamac` - America/Indiana/Winamac\n* `America/Indianapolis` - America/Indianapolis\n* `America/Inuvik` - America/Inuvik\n* `America/Iqaluit` - America/Iqaluit\n* `America/Jamaica` - America/Jamaica\n* `America/Jujuy` - America/Jujuy\n* `America/Juneau` - America/Juneau\n* `America/Kentucky/Louisville` - America/Kentucky/Louisville\n* `America/Kentucky/Monticello` - America/Kentucky/Monticello\n* `America/Knox_IN` - America/Knox_IN\n* `America/Kralendijk` - America/Kralendijk\n* `America/La_Paz` - America/La_Paz\n* `America/Lima` - America/Lima\n* `America/Los_Angeles` - America/Los_Angeles\n* `America/Louisville` - America/Louisville\n* `America/Lower_Princes` - America/Lower_Princes\n* `America/Maceio` - America/Maceio\n* `America/Managua` - America/Managua\n* `America/Manaus` - America/Manaus\n* `America/Marigot` - America/Marigot\n* `America/Martinique` - America/Martinique\n* `America/Matamoros` - America/Matamoros\n* `America/Mazatlan` - America/Mazatlan\n* `America/Mendoza` - America/Mendoza\n* `America/Menominee` - America/Menominee\n* `America/Merida` - America/Merida\n* `America/Metlakatla` - America/Metlakatla\n* `America/Mexico_City` - America/Mexico_City\n* `America/Miquelon` - America/Miquelon\n* `America/Moncton` - America/Moncton\n* `America/Monterrey` - America/Monterrey\n* `America/Montevideo` - America/Montevideo\n* `America/Montreal` - America/Montreal\n* `America/Montserrat` - America/Montserrat\n* `America/Nassau` - America/Nassau\n* `America/New_York` - America/New_York\n* `America/Nipigon` - America/Nipigon\n* `America/Nome` - America/Nome\n* `America/Noronha` - America/Noronha\n* `America/North_Dakota/Beulah` - America/North_Dakota/Beulah\n* `America/North_Dakota/Center` - America/North_Dakota/Center\n* `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem\n* `America/Nuuk` - America/Nuuk\n* `America/Ojinaga` - America/Ojinaga\n* `America/Panama` - America/Panama\n* `America/Pangnirtung` - America/Pangnirtung\n* `America/Paramaribo` - America/Paramaribo\n* `America/Phoenix` - America/Phoenix\n* `America/Port-au-Prince` - America/Port-au-Prince\n* `America/Port_of_Spain` - America/Port_of_Spain\n* `America/Porto_Acre` - America/Porto_Acre\n* `America/Porto_Velho` - America/Porto_Velho\n* `America/Puerto_Rico` - America/Puerto_Rico\n* `America/Punta_Arenas` - America/Punta_Arenas\n* `America/Rainy_River` - America/Rainy_River\n* `America/Rankin_Inlet` - America/Rankin_Inlet\n* `America/Recife` - America/Recife\n* `America/Regina` - America/Regina\n* `America/Resolute` - America/Resolute\n* `America/Rio_Branco` - America/Rio_Branco\n* `America/Rosario` - America/Rosario\n* `America/Santa_Isabel` - America/Santa_Isabel\n* `America/Santarem` - America/Santarem\n* `America/Santiago` - America/Santiago\n* `America/Santo_Domingo` - America/Santo_Domingo\n* `America/Sao_Paulo` - America/Sao_Paulo\n* `America/Scoresbysund` - America/Scoresbysund\n* `America/Shiprock` - America/Shiprock\n* `America/Sitka` - America/Sitka\n* `America/St_Barthelemy` - America/St_Barthelemy\n* `America/St_Johns` - America/St_Johns\n* `America/St_Kitts` - America/St_Kitts\n* `America/St_Lucia` - America/St_Lucia\n* `America/St_Thomas` - America/St_Thomas\n* `America/St_Vincent` - America/St_Vincent\n* `America/Swift_Current` - America/Swift_Current\n* `America/Tegucigalpa` - America/Tegucigalpa\n* `America/Thule` - America/Thule\n* `America/Thunder_Bay` - America/Thunder_Bay\n* `America/Tijuana` - America/Tijuana\n* `America/Toronto` - America/Toronto\n* `America/Tortola` - America/Tortola\n* `America/Vancouver` - America/Vancouver\n* `America/Virgin` - America/Virgin\n* `America/Whitehorse` - America/Whitehorse\n* `America/Winnipeg` - America/Winnipeg\n* `America/Yakutat` - America/Yakutat\n* `America/Yellowknife` - America/Yellowknife\n* `Antarctica/Casey` - Antarctica/Casey\n* `Antarctica/Davis` - Antarctica/Davis\n* `Antarctica/DumontDUrville` - Antarctica/DumontDUrville\n* `Antarctica/Macquarie` - Antarctica/Macquarie\n* `Antarctica/Mawson` - Antarctica/Mawson\n* `Antarctica/McMurdo` - Antarctica/McMurdo\n* `Antarctica/Palmer` - Antarctica/Palmer\n* `Antarctica/Rothera` - Antarctica/Rothera\n* `Antarctica/South_Pole` - Antarctica/South_Pole\n* `Antarctica/Syowa` - Antarctica/Syowa\n* `Antarctica/Troll` - Antarctica/Troll\n* `Antarctica/Vostok` - Antarctica/Vostok\n* `Arctic/Longyearbyen` - Arctic/Longyearbyen\n* `Asia/Aden` - Asia/Aden\n* `Asia/Almaty` - Asia/Almaty\n* `Asia/Amman` - Asia/Amman\n* `Asia/Anadyr` - Asia/Anadyr\n* `Asia/Aqtau` - Asia/Aqtau\n* `Asia/Aqtobe` - Asia/Aqtobe\n* `Asia/Ashgabat` - Asia/Ashgabat\n* `Asia/Ashkhabad` - Asia/Ashkhabad\n* `Asia/Atyrau` - Asia/Atyrau\n* `Asia/Baghdad` - Asia/Baghdad\n* `Asia/Bahrain` - Asia/Bahrain\n* `Asia/Baku` - Asia/Baku\n* `Asia/Bangkok` - Asia/Bangkok\n* `Asia/Barnaul` - Asia/Barnaul\n* `Asia/Beirut` - Asia/Beirut\n* `Asia/Bishkek` - Asia/Bishkek\n* `Asia/Brunei` - Asia/Brunei\n* `Asia/Calcutta` - Asia/Calcutta\n* `Asia/Chita` - Asia/Chita\n* `Asia/Choibalsan` - Asia/Choibalsan\n* `Asia/Chongqing` - Asia/Chongqing\n* `Asia/Chungking` - Asia/Chungking\n* `Asia/Colombo` - Asia/Colombo\n* `Asia/Dacca` - Asia/Dacca\n* `Asia/Damascus` - Asia/Damascus\n* `Asia/Dhaka` - Asia/Dhaka\n* `Asia/Dili` - Asia/Dili\n* `Asia/Dubai` - Asia/Dubai\n* `Asia/Dushanbe` - Asia/Dushanbe\n* `Asia/Famagusta` - Asia/Famagusta\n* `Asia/Gaza` - Asia/Gaza\n* `Asia/Harbin` - Asia/Harbin\n* `Asia/Hebron` - Asia/Hebron\n* `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh\n* `Asia/Hong_Kong` - Asia/Hong_Kong\n* `Asia/Hovd` - Asia/Hovd\n* `Asia/Irkutsk` - Asia/Irkutsk\n* `Asia/Istanbul` - Asia/Istanbul\n* `Asia/Jakarta` - Asia/Jakarta\n* `Asia/Jayapura` - Asia/Jayapura\n* `Asia/Jerusalem` - Asia/Jerusalem\n* `Asia/Kabul` - Asia/Kabul\n* `Asia/Kamchatka` - Asia/Kamchatka\n* `Asia/Karachi` - Asia/Karachi\n* `Asia/Kashgar` - Asia/Kashgar\n* `Asia/Kathmandu` - Asia/Kathmandu\n* `Asia/Katmandu` - Asia/Katmandu\n* `Asia/Khandyga` - Asia/Khandyga\n* `Asia/Kolkata` - Asia/Kolkata\n* `Asia/Krasnoyarsk` - Asia/Krasnoyarsk\n* `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur\n* `Asia/Kuching` - Asia/Kuching\n* `Asia/Kuwait` - Asia/Kuwait\n* `Asia/Macao` - Asia/Macao\n* `Asia/Macau` - Asia/Macau\n* `Asia/Magadan` - Asia/Magadan\n* `Asia/Makassar` - Asia/Makassar\n* `Asia/Manila` - Asia/Manila\n* `Asia/Muscat` - Asia/Muscat\n* `Asia/Nicosia` - Asia/Nicosia\n* `Asia/Novokuznetsk` - Asia/Novokuznetsk\n* `Asia/Novosibirsk` - Asia/Novosibirsk\n* `Asia/Omsk` - Asia/Omsk\n* `Asia/Oral` - Asia/Oral\n* `Asia/Phnom_Penh` - Asia/Phnom_Penh\n* `Asia/Pontianak` - Asia/Pontianak\n* `Asia/Pyongyang` - Asia/Pyongyang\n* `Asia/Qatar` - Asia/Qatar\n* `Asia/Qostanay` - Asia/Qostanay\n* `Asia/Qyzylorda` - Asia/Qyzylorda\n* `Asia/Rangoon` - Asia/Rangoon\n* `Asia/Riyadh` - Asia/Riyadh\n* `Asia/Saigon` - Asia/Saigon\n* `Asia/Sakhalin` - Asia/Sakhalin\n* `Asia/Samarkand` - Asia/Samarkand\n* `Asia/Seoul` - Asia/Seoul\n* `Asia/Shanghai` - Asia/Shanghai\n* `Asia/Singapore` - Asia/Singapore\n* `Asia/Srednekolymsk` - Asia/Srednekolymsk\n* `Asia/Taipei` - Asia/Taipei\n* `Asia/Tashkent` - Asia/Tashkent\n* `Asia/Tbilisi` - Asia/Tbilisi\n* `Asia/Tehran` - Asia/Tehran\n* `Asia/Tel_Aviv` - Asia/Tel_Aviv\n* `Asia/Thimbu` - Asia/Thimbu\n* `Asia/Thimphu` - Asia/Thimphu\n* `Asia/Tokyo` - Asia/Tokyo\n* `Asia/Tomsk` - Asia/Tomsk\n* `Asia/Ujung_Pandang` - Asia/Ujung_Pandang\n* `Asia/Ulaanbaatar` - Asia/Ulaanbaatar\n* `Asia/Ulan_Bator` - Asia/Ulan_Bator\n* `Asia/Urumqi` - Asia/Urumqi\n* `Asia/Ust-Nera` - Asia/Ust-Nera\n* `Asia/Vientiane` - Asia/Vientiane\n* `Asia/Vladivostok` - Asia/Vladivostok\n* `Asia/Yakutsk` - Asia/Yakutsk\n* `Asia/Yangon` - Asia/Yangon\n* `Asia/Yekaterinburg` - Asia/Yekaterinburg\n* `Asia/Yerevan` - Asia/Yerevan\n* `Atlantic/Azores` - Atlantic/Azores\n* `Atlantic/Bermuda` - Atlantic/Bermuda\n* `Atlantic/Canary` - Atlantic/Canary\n* `Atlantic/Cape_Verde` - Atlantic/Cape_Verde\n* `Atlantic/Faeroe` - Atlantic/Faeroe\n* `Atlantic/Faroe` - Atlantic/Faroe\n* `Atlantic/Jan_Mayen` - Atlantic/Jan_Mayen\n* `Atlantic/Madeira` - Atlantic/Madeira\n* `Atlantic/Reykjavik` - Atlantic/Reykjavik\n* `Atlantic/South_Georgia` - Atlantic/South_Georgia\n* `Atlantic/St_Helena` - Atlantic/St_Helena\n* `Atlantic/Stanley` - Atlantic/Stanley\n* `Australia/ACT` - Australia/ACT\n* `Australia/Adelaide` - Australia/Adelaide\n* `Australia/Brisbane` - Australia/Brisbane\n* `Australia/Broken_Hill` - Australia/Broken_Hill\n* `Australia/Canberra` - Australia/Canberra\n* `Australia/Currie` - Australia/Currie\n* `Australia/Darwin` - Australia/Darwin\n* `Australia/Eucla` - Australia/Eucla\n* `Australia/Hobart` - Australia/Hobart\n* `Australia/LHI` - Australia/LHI\n* `Australia/Lindeman` - Australia/Lindeman\n* `Australia/Lord_Howe` - Australia/Lord_Howe\n* `Australia/Melbourne` - Australia/Melbourne\n* `Australia/NSW` - Australia/NSW\n* `Australia/North` - Australia/North\n* `Australia/Perth` - Australia/Perth\n* `Australia/Queensland` - Australia/Queensland\n* `Australia/South` - Australia/South\n* `Australia/Sydney` - Australia/Sydney\n* `Australia/Tasmania` - Australia/Tasmania\n* `Australia/Victoria` - Australia/Victoria\n* `Australia/West` - Australia/West\n* `Australia/Yancowinna` - Australia/Yancowinna\n* `Brazil/Acre` - Brazil/Acre\n* `Brazil/DeNoronha` - Brazil/DeNoronha\n* `Brazil/East` - Brazil/East\n* `Brazil/West` - Brazil/West\n* `CET` - CET\n* `CST6CDT` - CST6CDT\n* `Canada/Atlantic` - Canada/Atlantic\n* `Canada/Central` - Canada/Central\n* `Canada/Eastern` - Canada/Eastern\n* `Canada/Mountain` - Canada/Mountain\n* `Canada/Newfoundland` - Canada/Newfoundland\n* `Canada/Pacific` - Canada/Pacific\n* `Canada/Saskatchewan` - Canada/Saskatchewan\n* `Canada/Yukon` - Canada/Yukon\n* `Chile/Continental` - Chile/Continental\n* `Chile/EasterIsland` - Chile/EasterIsland\n* `Cuba` - Cuba\n* `EET` - EET\n* `EST` - EST\n* `EST5EDT` - EST5EDT\n* `Egypt` - Egypt\n* `Eire` - Eire\n* `Etc/GMT` - Etc/GMT\n* `Etc/GMT+0` - Etc/GMT+0\n* `Etc/GMT+1` - Etc/GMT+1\n* `Etc/GMT+10` - Etc/GMT+10\n* `Etc/GMT+11` - Etc/GMT+11\n* `Etc/GMT+12` - Etc/GMT+12\n* `Etc/GMT+2` - Etc/GMT+2\n* `Etc/GMT+3` - Etc/GMT+3\n* `Etc/GMT+4` - Etc/GMT+4\n* `Etc/GMT+5` - Etc/GMT+5\n* `Etc/GMT+6` - Etc/GMT+6\n* `Etc/GMT+7` - Etc/GMT+7\n* `Etc/GMT+8` - Etc/GMT+8\n* `Etc/GMT+9` - Etc/GMT+9\n* `Etc/GMT-0` - Etc/GMT-0\n* `Etc/GMT-1` - Etc/GMT-1\n* `Etc/GMT-10` - Etc/GMT-10\n* `Etc/GMT-11` - Etc/GMT-11\n* `Etc/GMT-12` - Etc/GMT-12\n* `Etc/GMT-13` - Etc/GMT-13\n* `Etc/GMT-14` - Etc/GMT-14\n* `Etc/GMT-2` - Etc/GMT-2\n* `Etc/GMT-3` - Etc/GMT-3\n* `Etc/GMT-4` - Etc/GMT-4\n* `Etc/GMT-5` - Etc/GMT-5\n* `Etc/GMT-6` - Etc/GMT-6\n* `Etc/GMT-7` - Etc/GMT-7\n* `Etc/GMT-8` - Etc/GMT-8\n* `Etc/GMT-9` - Etc/GMT-9\n* `Etc/GMT0` - Etc/GMT0\n* `Etc/Greenwich` - Etc/Greenwich\n* `Etc/UCT` - Etc/UCT\n* `Etc/UTC` - Etc/UTC\n* `Etc/Universal` - Etc/Universal\n* `Etc/Zulu` - Etc/Zulu\n* `Europe/Amsterdam` - Europe/Amsterdam\n* `Europe/Andorra` - Europe/Andorra\n* `Europe/Astrakhan` - Europe/Astrakhan\n* `Europe/Athens` - Europe/Athens\n* `Europe/Belfast` - Europe/Belfast\n* `Europe/Belgrade` - Europe/Belgrade\n* `Europe/Berlin` - Europe/Berlin\n* `Europe/Bratislava` - Europe/Bratislava\n* `Europe/Brussels` - Europe/Brussels\n* `Europe/Bucharest` - Europe/Bucharest\n* `Europe/Budapest` - Europe/Budapest\n* `Europe/Busingen` - Europe/Busingen\n* `Europe/Chisinau` - Europe/Chisinau\n* `Europe/Copenhagen` - Europe/Copenhagen\n* `Europe/Dublin` - Europe/Dublin\n* `Europe/Gibraltar` - Europe/Gibraltar\n* `Europe/Guernsey` - Europe/Guernsey\n* `Europe/Helsinki` - Europe/Helsinki\n* `Europe/Isle_of_Man` - Europe/Isle_of_Man\n* `Europe/Istanbul` - Europe/Istanbul\n* `Europe/Jersey` - Europe/Jersey\n* `Europe/Kaliningrad` - Europe/Kaliningrad\n* `Europe/Kiev` - Europe/Kiev\n* `Europe/Kirov` - Europe/Kirov\n* `Europe/Kyiv` - Europe/Kyiv\n* `Europe/Lisbon` - Europe/Lisbon\n* `Europe/Ljubljana` - Europe/Ljubljana\n* `Europe/London` - Europe/London\n* `Europe/Luxembourg` - Europe/Luxembourg\n* `Europe/Madrid` - Europe/Madrid\n* `Europe/Malta` - Europe/Malta\n* `Europe/Mariehamn` - Europe/Mariehamn\n* `Europe/Minsk` - Europe/Minsk\n* `Europe/Monaco` - Europe/Monaco\n* `Europe/Moscow` - Europe/Moscow\n* `Europe/Nicosia` - Europe/Nicosia\n* `Europe/Oslo` - Europe/Oslo\n* `Europe/Paris` - Europe/Paris\n* `Europe/Podgorica` - Europe/Podgorica\n* `Europe/Prague` - Europe/Prague\n* `Europe/Riga` - Europe/Riga\n* `Europe/Rome` - Europe/Rome\n* `Europe/Samara` - Europe/Samara\n* `Europe/San_Marino` - Europe/San_Marino\n* `Europe/Sarajevo` - Europe/Sarajevo\n* `Europe/Saratov` - Europe/Saratov\n* `Europe/Simferopol` - Europe/Simferopol\n* `Europe/Skopje` - Europe/Skopje\n* `Europe/Sofia` - Europe/Sofia\n* `Europe/Stockholm` - Europe/Stockholm\n* `Europe/Tallinn` - Europe/Tallinn\n* `Europe/Tirane` - Europe/Tirane\n* `Europe/Tiraspol` - Europe/Tiraspol\n* `Europe/Ulyanovsk` - Europe/Ulyanovsk\n* `Europe/Uzhgorod` - Europe/Uzhgorod\n* `Europe/Vaduz` - Europe/Vaduz\n* `Europe/Vatican` - Europe/Vatican\n* `Europe/Vienna` - Europe/Vienna\n* `Europe/Vilnius` - Europe/Vilnius\n* `Europe/Volgograd` - Europe/Volgograd\n* `Europe/Warsaw` - Europe/Warsaw\n* `Europe/Zagreb` - Europe/Zagreb\n* `Europe/Zaporozhye` - Europe/Zaporozhye\n* `Europe/Zurich` - Europe/Zurich\n* `GB` - GB\n* `GB-Eire` - GB-Eire\n* `GMT` - GMT\n* `GMT+0` - GMT+0\n* `GMT-0` - GMT-0\n* `GMT0` - GMT0\n* `Greenwich` - Greenwich\n* `HST` - HST\n* `Hongkong` - Hongkong\n* `Iceland` - Iceland\n* `Indian/Antananarivo` - Indian/Antananarivo\n* `Indian/Chagos` - Indian/Chagos\n* `Indian/Christmas` - Indian/Christmas\n* `Indian/Cocos` - Indian/Cocos\n* `Indian/Comoro` - Indian/Comoro\n* `Indian/Kerguelen` - Indian/Kerguelen\n* `Indian/Mahe` - Indian/Mahe\n* `Indian/Maldives` - Indian/Maldives\n* `Indian/Mauritius` - Indian/Mauritius\n* `Indian/Mayotte` - Indian/Mayotte\n* `Indian/Reunion` - Indian/Reunion\n* `Iran` - Iran\n* `Israel` - Israel\n* `Jamaica` - Jamaica\n* `Japan` - Japan\n* `Kwajalein` - Kwajalein\n* `Libya` - Libya\n* `MET` - MET\n* `MST` - MST\n* `MST7MDT` - MST7MDT\n* `Mexico/BajaNorte` - Mexico/BajaNorte\n* `Mexico/BajaSur` - Mexico/BajaSur\n* `Mexico/General` - Mexico/General\n* `NZ` - NZ\n* `NZ-CHAT` - NZ-CHAT\n* `Navajo` - Navajo\n* `PRC` - PRC\n* `PST8PDT` - PST8PDT\n* `Pacific/Apia` - Pacific/Apia\n* `Pacific/Auckland` - Pacific/Auckland\n* `Pacific/Bougainville` - Pacific/Bougainville\n* `Pacific/Chatham` - Pacific/Chatham\n* `Pacific/Chuuk` - Pacific/Chuuk\n* `Pacific/Easter` - Pacific/Easter\n* `Pacific/Efate` - Pacific/Efate\n* `Pacific/Enderbury` - Pacific/Enderbury\n* `Pacific/Fakaofo` - Pacific/Fakaofo\n* `Pacific/Fiji` - Pacific/Fiji\n* `Pacific/Funafuti` - Pacific/Funafuti\n* `Pacific/Galapagos` - Pacific/Galapagos\n* `Pacific/Gambier` - Pacific/Gambier\n* `Pacific/Guadalcanal` - Pacific/Guadalcanal\n* `Pacific/Guam` - Pacific/Guam\n* `Pacific/Honolulu` - Pacific/Honolulu\n* `Pacific/Johnston` - Pacific/Johnston\n* `Pacific/Kanton` - Pacific/Kanton\n* `Pacific/Kiritimati` - Pacific/Kiritimati\n* `Pacific/Kosrae` - Pacific/Kosrae\n* `Pacific/Kwajalein` - Pacific/Kwajalein\n* `Pacific/Majuro` - Pacific/Majuro\n* `Pacific/Marquesas` - Pacific/Marquesas\n* `Pacific/Midway` - Pacific/Midway\n* `Pacific/Nauru` - Pacific/Nauru\n* `Pacific/Niue` - Pacific/Niue\n* `Pacific/Norfolk` - Pacific/Norfolk\n* `Pacific/Noumea` - Pacific/Noumea\n* `Pacific/Pago_Pago` - Pacific/Pago_Pago\n* `Pacific/Palau` - Pacific/Palau\n* `Pacific/Pitcairn` - Pacific/Pitcairn\n* `Pacific/Pohnpei` - Pacific/Pohnpei\n* `Pacific/Ponape` - Pacific/Ponape\n* `Pacific/Port_Moresby` - Pacific/Port_Moresby\n* `Pacific/Rarotonga` - Pacific/Rarotonga\n* `Pacific/Saipan` - Pacific/Saipan\n* `Pacific/Samoa` - Pacific/Samoa\n* `Pacific/Tahiti` - Pacific/Tahiti\n* `Pacific/Tarawa` - Pacific/Tarawa\n* `Pacific/Tongatapu` - Pacific/Tongatapu\n* `Pacific/Truk` - Pacific/Truk\n* `Pacific/Wake` - Pacific/Wake\n* `Pacific/Wallis` - Pacific/Wallis\n* `Pacific/Yap` - Pacific/Yap\n* `Poland` - Poland\n* `Portugal` - Portugal\n* `ROC` - ROC\n* `ROK` - ROK\n* `Singapore` - Singapore\n* `Turkey` - Turkey\n* `UCT` - UCT\n* `US/Alaska` - US/Alaska\n* `US/Aleutian` - US/Aleutian\n* `US/Arizona` - US/Arizona\n* `US/Central` - US/Central\n* `US/East-Indiana` - US/East-Indiana\n* `US/Eastern` - US/Eastern\n* `US/Hawaii` - US/Hawaii\n* `US/Indiana-Starke` - US/Indiana-Starke\n* `US/Michigan` - US/Michigan\n* `US/Mountain` - US/Mountain\n* `US/Pacific` - US/Pacific\n* `US/Samoa` - US/Samoa\n* `UTC` - UTC\n* `Universal` - Universal\n* `W-SU` - W-SU\n* `WET` - WET\n* `Zulu` - Zulu"
}
}
}
TrendsFilter
{
"type": "object",
"title": "TrendsFilter",
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"formula": {
"type": "string",
"title": "Formula",
"default": null,
"nullable": true
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"decimalPlaces": {
"type": "number",
"title": "Decimalplaces",
"default": null,
"nullable": true
},
"showLabelsOnSeries": {
"type": "boolean",
"title": "Showlabelsonseries",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"smoothingIntervals": {
"type": "number",
"title": "Smoothingintervals",
"default": null,
"nullable": true
},
"showPercentStackView": {
"type": "boolean",
"title": "Showpercentstackview",
"default": null,
"nullable": true
},
"aggregationAxisFormat": {
"$ref": "#/components/schemas/AggregationAxisFormatNullable"
},
"aggregationAxisPrefix": {
"type": "string",
"title": "Aggregationaxisprefix",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
},
"aggregationAxisPostfix": {
"type": "string",
"title": "Aggregationaxispostfix",
"default": null,
"nullable": true
},
"breakdown_histogram_bin_count": {
"type": "number",
"title": "Breakdown Histogram Bin Count",
"default": null,
"nullable": true
}
}
}
TrendsFilterNullable
{
"type": "object",
"title": "TrendsFilter",
"default": null,
"nullable": true,
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"formula": {
"type": "string",
"title": "Formula",
"default": null,
"nullable": true
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"decimalPlaces": {
"type": "number",
"title": "Decimalplaces",
"default": null,
"nullable": true
},
"showLabelsOnSeries": {
"type": "boolean",
"title": "Showlabelsonseries",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"smoothingIntervals": {
"type": "number",
"title": "Smoothingintervals",
"default": null,
"nullable": true
},
"showPercentStackView": {
"type": "boolean",
"title": "Showpercentstackview",
"default": null,
"nullable": true
},
"aggregationAxisFormat": {
"$ref": "#/components/schemas/AggregationAxisFormatNullable"
},
"aggregationAxisPrefix": {
"type": "string",
"title": "Aggregationaxisprefix",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
},
"aggregationAxisPostfix": {
"type": "string",
"title": "Aggregationaxispostfix",
"default": null,
"nullable": true
},
"breakdown_histogram_bin_count": {
"type": "number",
"title": "Breakdown Histogram Bin Count",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the trends insight"
}
TrendsQuery
{
"type": "object",
"title": "TrendsQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "TrendsQuery",
"title": "Kind",
"default": "TrendsQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"response": {
"$ref": "#/components/schemas/TrendsQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"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"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"trendsFilter": {
"$ref": "#/components/schemas/TrendsFilterNullable"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"breakdownFilter": {
"$ref": "#/components/schemas/BreakdownFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
}
}
TrendsQueryResponse
{
"type": "object",
"title": "TrendsQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
TrendsQueryResponseNullable
{
"type": "object",
"title": "TrendsQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
Type7baEnum
{
"enum": [
"popover",
"widget",
"button",
"email",
"full_screen",
"api"
],
"type": "string",
"description": "* `popover` - popover\n* `widget` - widget\n* `button` - button\n* `email` - email\n* `full_screen` - full screen\n* `api` - api"
}
UrlMatchingEnum
{
"enum": [
"contains",
"regex",
"exact"
],
"type": "string",
"description": "* `contains` - contains\n* `regex` - regex\n* `exact` - exact"
}
User
{
"type": "object",
"required": [
"date_joined",
"email",
"has_password",
"has_social_auth",
"is_2fa_enabled",
"is_impersonated",
"organization",
"organizations",
"password",
"scene_personalisation",
"team",
"uuid"
],
"properties": {
"team": {
"$ref": "#/components/schemas/TeamBasic"
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"email": {
"type": "string",
"title": "Email address",
"format": "email",
"maxLength": 254
},
"is_staff": {
"type": "boolean",
"title": "Staff status",
"description": "Designates whether the user can log into this admin site."
},
"password": {
"type": "string",
"maxLength": 128,
"writeOnly": true
},
"last_name": {
"type": "string",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 150
},
"theme_mode": {
"oneOf": [
{
"$ref": "#/components/schemas/ThemeModeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"date_joined": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"distinct_id": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"email_opt_in": {
"type": "boolean",
"nullable": true
},
"has_password": {
"type": "boolean",
"readOnly": true
},
"organization": {
"$ref": "#/components/schemas/Organization"
},
"toolbar_mode": {
"oneOf": [
{
"$ref": "#/components/schemas/ToolbarModeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"organizations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationBasic"
},
"readOnly": true
},
"pending_email": {
"type": "string",
"title": "Pending email address awaiting verification",
"format": "email",
"nullable": true,
"maxLength": 254
},
"anonymize_data": {
"type": "boolean",
"nullable": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
},
"is_impersonated": {
"type": "boolean",
"nullable": true,
"readOnly": true
},
"current_password": {
"type": "string",
"writeOnly": true
},
"set_current_team": {
"type": "string",
"writeOnly": true
},
"is_email_verified": {
"type": "boolean",
"nullable": true
},
"events_column_config": {},
"notification_settings": {
"type": "object",
"additionalProperties": {}
},
"scene_personalisation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScenePersonalisationBasic"
},
"readOnly": true
},
"set_current_organization": {
"type": "string",
"writeOnly": true
},
"has_seen_product_intro_for": {
"nullable": true
}
},
"x-konfig-properties": {
"team": {
"readOnly": true
},
"organization": {
"readOnly": true
}
}
}
UserBasic
{
"type": "object",
"required": [
"email",
"id",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"email": {
"type": "string",
"title": "Email address",
"format": "email",
"maxLength": 254
},
"last_name": {
"type": "string",
"maxLength": 150
},
"first_name": {
"type": "string",
"maxLength": 150
},
"distinct_id": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"is_email_verified": {
"type": "boolean",
"nullable": true
}
}
}
VizSpecificOptions
{
"type": "object",
"title": "VizSpecificOptions",
"properties": {
"RETENTION": {
"type": "null",
"title": "Retention",
"default": null
},
"ActionsPie": {
"type": "null",
"title": "Actionspie",
"default": null
}
}
}
VizSpecificOptionsNullable
{
"type": "object",
"title": "VizSpecificOptions",
"default": null,
"nullable": true,
"properties": {
"RETENTION": {
"type": "null",
"title": "Retention",
"default": null
},
"ActionsPie": {
"type": "null",
"title": "Actionspie",
"default": null
}
}
}
WebOverviewItem
{
"type": "object",
"title": "WebOverviewItem",
"required": [
"key",
"kind"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"kind": {
"$ref": "#/components/schemas/Kind2"
},
"value": {
"type": "number",
"title": "Value",
"default": null,
"nullable": true
},
"previous": {
"type": "number",
"title": "Previous",
"default": null,
"nullable": true
},
"isIncreaseBad": {
"type": "boolean",
"title": "Isincreasebad",
"default": null,
"nullable": true
},
"changeFromPreviousPct": {
"type": "number",
"title": "Changefrompreviouspct",
"default": null,
"nullable": true
}
}
}
WebOverviewQuery
{
"type": "object",
"title": "WebOverviewQuery",
"required": [
"properties"
],
"properties": {
"kind": {
"const": "WebOverviewQuery",
"title": "Kind",
"default": "WebOverviewQuery"
},
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"response": {
"$ref": "#/components/schemas/WebOverviewQueryResponseNullable"
},
"sampling": {
"$ref": "#/components/schemas/SamplingNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
}
]
},
"title": "Properties"
},
"useSessionsTable": {
"type": "boolean",
"title": "Usesessionstable",
"default": null,
"nullable": true
}
}
}
WebOverviewQueryResponse
{
"type": "object",
"title": "WebOverviewQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebOverviewItem"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WebOverviewQueryResponseNullable
{
"type": "object",
"title": "WebOverviewQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebOverviewItem"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WebStatsBreakdown
{
"enum": [
"Page",
"InitialPage",
"InitialChannelType",
"InitialReferringDomain",
"InitialUTMSource",
"InitialUTMCampaign",
"InitialUTMMedium",
"InitialUTMTerm",
"InitialUTMContent",
"Browser",
"OS",
"DeviceType",
"Country",
"Region",
"City"
],
"type": "string",
"title": "WebStatsBreakdown"
}
WebStatsTableQuery
{
"type": "object",
"title": "WebStatsTableQuery",
"required": [
"breakdownBy",
"properties"
],
"properties": {
"kind": {
"const": "WebStatsTableQuery",
"title": "Kind",
"default": "WebStatsTableQuery"
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"response": {
"$ref": "#/components/schemas/WebStatsTableQueryResponseNullable"
},
"sampling": {
"$ref": "#/components/schemas/SamplingNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
}
]
},
"title": "Properties"
},
"breakdownBy": {
"$ref": "#/components/schemas/WebStatsBreakdown"
},
"doPathCleaning": {
"type": "boolean",
"title": "Dopathcleaning",
"default": null,
"nullable": true
},
"useSessionsTable": {
"type": "boolean",
"title": "Usesessionstable",
"default": null,
"nullable": true
},
"includeBounceRate": {
"type": "boolean",
"title": "Includebouncerate",
"default": null,
"nullable": true
},
"includeScrollDepth": {
"type": "boolean",
"title": "Includescrolldepth",
"default": null,
"nullable": true
}
}
}
WebStatsTableQueryResponse
{
"type": "object",
"title": "WebStatsTableQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WebStatsTableQueryResponseNullable
{
"type": "object",
"title": "WebStatsTableQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"limit": {
"type": "integer",
"title": "Limit",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"offset": {
"type": "integer",
"title": "Offset",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WebTopClicksQuery
{
"type": "object",
"title": "WebTopClicksQuery",
"required": [
"properties"
],
"properties": {
"kind": {
"const": "WebTopClicksQuery",
"title": "Kind",
"default": "WebTopClicksQuery"
},
"response": {
"$ref": "#/components/schemas/WebTopClicksQueryResponseNullable"
},
"sampling": {
"$ref": "#/components/schemas/SamplingNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
}
]
},
"title": "Properties"
},
"useSessionsTable": {
"type": "boolean",
"title": "Usesessionstable",
"default": null,
"nullable": true
}
}
}
WebTopClicksQueryResponse
{
"type": "object",
"title": "WebTopClicksQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WebTopClicksQueryResponseNullable
{
"type": "object",
"title": "WebTopClicksQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"types": {
"type": "array",
"items": {},
"title": "Types",
"default": null,
"nullable": true
},
"columns": {
"type": "array",
"items": {},
"title": "Columns",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"samplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
WeekStartDayEnum
{
"enum": [
0,
1
],
"type": "integer",
"description": "* `0` - Sunday\n* `1` - Monday"
}