openapi: 3.0.3 info: title: PostHog actions insights API version: 1.0.0 description: '' tags: - name: insights paths: /api/environments/{environment_id}/insights/: get: operationId: environments_insights_list description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: basic schema: type: boolean description: Return basic insight metadata only (no results, faster). - in: query name: created_by schema: type: string description: JSON-encoded array of user IDs. Only returns insights whose `created_by` is in the list, e.g. `[1,42]`. - in: query name: created_date_from schema: type: string description: Filter by `created_at > created_date_from`. Accepts absolute or relative dates. - in: query name: created_date_to schema: type: string description: Filter by `created_at < created_date_to`. Accepts absolute or relative dates. - in: query name: dashboards schema: type: string description: JSON-encoded array of dashboard IDs. Returns insights attached to every listed dashboard (AND). - in: query name: date_from schema: type: string description: Filter by `last_modified_at > date_from`. Accepts absolute dates (`2025-04-23`) or relative strings (`-7d`, `-1m`). - in: query name: date_to schema: type: string description: Filter by `last_modified_at < date_to`. Accepts absolute dates or relative strings. - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: favorited schema: type: boolean description: Include this parameter (any value) to restrict results to insights marked as favorited. - in: query name: format schema: type: string enum: - csv - json - in: query name: insight schema: type: string enum: - FUNNELS - JSON - LIFECYCLE - PATHS - RETENTION - SQL - STICKINESS - TRENDS description: Restrict to a single insight type. `JSON` matches non-wrapper query insights; `SQL` matches HogQL queries. - in: query name: last_viewed_date_from schema: type: string description: Filter by `last_viewed_at > last_viewed_date_from`. Accepts absolute or relative dates. - in: query name: last_viewed_date_to schema: type: string description: Filter by `last_viewed_at < last_viewed_date_to`. Accepts absolute or relative dates. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: refresh schema: type: string enum: - async - async_except_on_cache_miss - blocking - force_async - force_blocking - force_cache - lazy_async default: force_cache description: ' Whether to refresh the retrieved insights, how aggressively, and if sync or async: - `''force_cache''` - return cached data or a cache miss; always completes immediately as it never calculates - `''blocking''` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache - `''async''` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache - `''lazy_async''` - kick off background calculation, UNLESS there are somewhat fresh results in the cache - `''force_blocking''` - calculate synchronously, even if fresh results are already cached - `''force_async''` - kick off background calculation, even if fresh results are already cached Background calculation can be tracked using the `query_status` response field.' - in: query name: saved schema: type: boolean description: When truthy, restricts results to insights that are saved (or attached to a visible dashboard). When falsy, only unsaved insights. - in: query name: search schema: type: string description: Case-insensitive substring match across name, derived_name, description, and tag names. - in: query name: short_id schema: type: string - in: query name: tags schema: type: string description: JSON-encoded array of tag names. Returns insights with any of the listed tags. - in: query name: user schema: type: boolean description: Include this parameter (any value) to restrict results to insights created by the authenticated user. tags: - insights security: - PersonalAPIKeyAuth: - insight:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInsightList' text/csv: schema: $ref: '#/components/schemas/PaginatedInsightList' description: '' deprecated: true x-explicit-tags: - product_analytics post: operationId: environments_insights_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '201': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/{insight_id}/sharing/: get: operationId: environments_insights_sharing_list parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: insight_id schema: type: integer required: true tags: - insights security: - PersonalAPIKeyAuth: - sharing_configuration:read responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SharingConfiguration' description: '' deprecated: true x-explicit-tags: - core /api/environments/{environment_id}/insights/{insight_id}/sharing/passwords/: post: operationId: environments_insights_sharing_passwords_create description: Create a new password for the sharing configuration. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: insight_id schema: type: integer required: true tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SharingConfiguration' multipart/form-data: schema: $ref: '#/components/schemas/SharingConfiguration' security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' description: '' deprecated: true x-explicit-tags: - core /api/environments/{environment_id}/insights/{insight_id}/sharing/passwords/{password_id}/: delete: operationId: environments_insights_sharing_passwords_destroy description: Delete a password from the sharing configuration. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: insight_id schema: type: integer required: true - in: path name: password_id schema: type: string required: true tags: - insights security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '204': description: No response body deprecated: true x-explicit-tags: - core /api/environments/{environment_id}/insights/{insight_id}/sharing/refresh/: post: operationId: environments_insights_sharing_refresh_create parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: insight_id schema: type: integer required: true tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SharingConfiguration' multipart/form-data: schema: $ref: '#/components/schemas/SharingConfiguration' security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' description: '' deprecated: true x-explicit-tags: - core /api/environments/{environment_id}/insights/{insight_id}/thresholds/: get: operationId: environments_insights_thresholds_list parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: insight_id schema: type: integer required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer tags: - insights security: - PersonalAPIKeyAuth: - alert:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedThresholdWithAlertList' description: '' deprecated: true x-explicit-tags: [] /api/environments/{environment_id}/insights/{insight_id}/thresholds/{id}/: get: operationId: environments_insights_thresholds_retrieve parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: path name: id schema: type: string format: uuid description: A UUID string identifying this threshold. required: true - in: path name: insight_id schema: type: integer required: true tags: - insights security: - PersonalAPIKeyAuth: - alert:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThresholdWithAlert' description: '' deprecated: true x-explicit-tags: [] /api/environments/{environment_id}/insights/{id}/: get: operationId: environments_insights_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: query name: from_dashboard schema: type: integer description: ' Only if loading an insight in the context of a dashboard: The relevant dashboard''s ID. When set, the specified dashboard''s filters and date range override will be applied.' - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true - in: query name: refresh schema: type: string enum: - async - async_except_on_cache_miss - blocking - force_async - force_blocking - force_cache - lazy_async default: force_cache description: ' Whether to refresh the insight, how aggresively, and if sync or async: - `''force_cache''` - return cached data or a cache miss; always completes immediately as it never calculates - `''blocking''` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache - `''async''` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache - `''lazy_async''` - kick off background calculation, UNLESS there are somewhat fresh results in the cache - `''force_blocking''` - calculate synchronously, even if fresh results are already cached - `''force_async''` - kick off background calculation, even if fresh results are already cached Background calculation can be tracked using the `query_status` response field.' tags: - insights security: - PersonalAPIKeyAuth: - insight:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' deprecated: true x-explicit-tags: - product_analytics put: operationId: environments_insights_update description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' deprecated: true x-explicit-tags: - product_analytics patch: operationId: environments_insights_partial_update description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInsight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' deprecated: true x-explicit-tags: - product_analytics delete: operationId: environments_insights_destroy description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true tags: - insights security: - PersonalAPIKeyAuth: - insight:write responses: '405': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/{id}/activity/: get: operationId: environments_insights_activity_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true tags: - insights security: - PersonalAPIKeyAuth: - activity_log:read responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/{id}/analyze/: get: operationId: environments_insights_analyze_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true tags: - insights responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/{id}/suggestions/: get: operationId: environments_insights_suggestions_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true tags: - insights responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics post: operationId: environments_insights_suggestions_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/activity/: get: operationId: environments_insights_all_activity_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights security: - PersonalAPIKeyAuth: - activity_log:read responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/bulk_update_tags/: post: operationId: environments_insights_bulk_update_tags_create description: 'Bulk update tags on multiple objects. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkUpdateTagsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkUpdateTagsResponse' text/csv: schema: $ref: '#/components/schemas/BulkUpdateTagsResponse' description: '' deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/cancel/: post: operationId: environments_insights_cancel_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/generate_metadata/: post: operationId: environments_insights_generate_metadata_create description: Generate an AI-suggested name and description for an insight based on its query configuration. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/my_last_viewed/: get: operationId: environments_insights_my_last_viewed_retrieve description: Returns basic details about the last 5 insights viewed by this user. Most recently viewed first. parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/trending/: get: operationId: environments_insights_trending_retrieve description: 'Returns trending insights based on view count in the last N days (default 7). Defaults to returning top 10 insights.' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/environments/{environment_id}/insights/viewed/: post: operationId: environments_insights_viewed_create description: 'Update insight view timestamps. Expects: {"insight_ids": [1, 2, 3, ...]}' parameters: - $ref: '#/components/parameters/EnvironmentIdPath' - in: query name: format schema: type: string enum: - csv - json tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:read responses: '200': description: No response body deprecated: true x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/: get: operationId: insights_list description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: basic schema: type: boolean description: Return basic insight metadata only (no results, faster). - in: query name: created_by schema: type: string description: JSON-encoded array of user IDs. Only returns insights whose `created_by` is in the list, e.g. `[1,42]`. - in: query name: created_date_from schema: type: string description: Filter by `created_at > created_date_from`. Accepts absolute or relative dates. - in: query name: created_date_to schema: type: string description: Filter by `created_at < created_date_to`. Accepts absolute or relative dates. - in: query name: dashboards schema: type: string description: JSON-encoded array of dashboard IDs. Returns insights attached to every listed dashboard (AND). - in: query name: date_from schema: type: string description: Filter by `last_modified_at > date_from`. Accepts absolute dates (`2025-04-23`) or relative strings (`-7d`, `-1m`). - in: query name: date_to schema: type: string description: Filter by `last_modified_at < date_to`. Accepts absolute dates or relative strings. - in: query name: favorited schema: type: boolean description: Include this parameter (any value) to restrict results to insights marked as favorited. - in: query name: format schema: type: string enum: - csv - json - in: query name: insight schema: type: string enum: - FUNNELS - JSON - LIFECYCLE - PATHS - RETENTION - SQL - STICKINESS - TRENDS description: Restrict to a single insight type. `JSON` matches non-wrapper query insights; `SQL` matches HogQL queries. - in: query name: last_viewed_date_from schema: type: string description: Filter by `last_viewed_at > last_viewed_date_from`. Accepts absolute or relative dates. - in: query name: last_viewed_date_to schema: type: string description: Filter by `last_viewed_at < last_viewed_date_to`. Accepts absolute or relative dates. - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - $ref: '#/components/parameters/ProjectIdPath' - in: query name: refresh schema: type: string enum: - async - async_except_on_cache_miss - blocking - force_async - force_blocking - force_cache - lazy_async default: force_cache description: ' Whether to refresh the retrieved insights, how aggressively, and if sync or async: - `''force_cache''` - return cached data or a cache miss; always completes immediately as it never calculates - `''blocking''` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache - `''async''` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache - `''lazy_async''` - kick off background calculation, UNLESS there are somewhat fresh results in the cache - `''force_blocking''` - calculate synchronously, even if fresh results are already cached - `''force_async''` - kick off background calculation, even if fresh results are already cached Background calculation can be tracked using the `query_status` response field.' - in: query name: saved schema: type: boolean description: When truthy, restricts results to insights that are saved (or attached to a visible dashboard). When falsy, only unsaved insights. - in: query name: search schema: type: string description: Case-insensitive substring match across name, derived_name, description, and tag names. - in: query name: short_id schema: type: string - in: query name: tags schema: type: string description: JSON-encoded array of tag names. Returns insights with any of the listed tags. - in: query name: user schema: type: boolean description: Include this parameter (any value) to restrict results to insights created by the authenticated user. tags: - insights security: - PersonalAPIKeyAuth: - insight:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInsightList' text/csv: schema: $ref: '#/components/schemas/PaginatedInsightList' description: '' x-explicit-tags: - product_analytics post: operationId: insights_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '201': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/{insight_id}/sharing/: get: operationId: insights_sharing_list parameters: - in: path name: insight_id schema: type: integer required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - sharing_configuration:read responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SharingConfiguration' description: '' x-explicit-tags: - core /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/: post: operationId: insights_sharing_passwords_create description: Create a new password for the sharing configuration. parameters: - in: path name: insight_id schema: type: integer required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SharingConfiguration' multipart/form-data: schema: $ref: '#/components/schemas/SharingConfiguration' security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' description: '' x-explicit-tags: - core /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/{password_id}/: delete: operationId: insights_sharing_passwords_destroy description: Delete a password from the sharing configuration. parameters: - in: path name: insight_id schema: type: integer required: true - in: path name: password_id schema: type: string required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '204': description: No response body x-explicit-tags: - core /api/projects/{project_id}/insights/{insight_id}/sharing/refresh/: post: operationId: insights_sharing_refresh_create parameters: - in: path name: insight_id schema: type: integer required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SharingConfiguration' multipart/form-data: schema: $ref: '#/components/schemas/SharingConfiguration' security: - PersonalAPIKeyAuth: - sharing_configuration:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/SharingConfiguration' description: '' x-explicit-tags: - core /api/projects/{project_id}/insights/{insight_id}/thresholds/: get: operationId: insights_thresholds_list parameters: - in: path name: insight_id schema: type: integer required: true - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - alert:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedThresholdWithAlertList' description: '' x-explicit-tags: [] /api/projects/{project_id}/insights/{insight_id}/thresholds/{id}/: get: operationId: insights_thresholds_retrieve parameters: - in: path name: id schema: type: string format: uuid description: A UUID string identifying this threshold. required: true - in: path name: insight_id schema: type: integer required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - alert:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/ThresholdWithAlert' description: '' x-explicit-tags: [] /api/projects/{project_id}/insights/{id}/: get: operationId: insights_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: query name: from_dashboard schema: type: integer description: ' Only if loading an insight in the context of a dashboard: The relevant dashboard''s ID. When set, the specified dashboard''s filters and date range override will be applied.' - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true - $ref: '#/components/parameters/ProjectIdPath' - in: query name: refresh schema: type: string enum: - async - async_except_on_cache_miss - blocking - force_async - force_blocking - force_cache - lazy_async default: force_cache description: ' Whether to refresh the insight, how aggresively, and if sync or async: - `''force_cache''` - return cached data or a cache miss; always completes immediately as it never calculates - `''blocking''` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache - `''async''` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache - `''lazy_async''` - kick off background calculation, UNLESS there are somewhat fresh results in the cache - `''force_blocking''` - calculate synchronously, even if fresh results are already cached - `''force_async''` - kick off background calculation, even if fresh results are already cached Background calculation can be tracked using the `query_status` response field.' tags: - insights security: - PersonalAPIKeyAuth: - insight:read responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' x-explicit-tags: - product_analytics put: operationId: insights_update description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' x-explicit-tags: - product_analytics patch: operationId: insights_partial_update description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInsight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': content: application/json: schema: $ref: '#/components/schemas/Insight' text/csv: schema: $ref: '#/components/schemas/Insight' description: '' x-explicit-tags: - product_analytics delete: operationId: insights_destroy description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: oneOf: - type: integer - type: string description: Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - insight:write responses: '405': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/{id}/activity/: get: operationId: insights_activity_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - activity_log:read responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/{id}/analyze/: get: operationId: insights_analyze_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/{id}/suggestions/: get: operationId: insights_suggestions_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights responses: '200': description: No response body x-explicit-tags: - product_analytics post: operationId: insights_suggestions_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - in: path name: id schema: type: integer description: A unique integer value identifying this insight. required: true - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/activity/: get: operationId: insights_all_activity_retrieve description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights security: - PersonalAPIKeyAuth: - activity_log:read responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/bulk_update_tags/: post: operationId: insights_bulk_update_tags_create description: 'Bulk update tags on multiple objects. Accepts: - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]} Actions: - "add": Add tags to existing tags on each object - "remove": Remove specific tags from each object - "set": Replace all tags on each object with the provided list' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkUpdateTagsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkUpdateTagsResponse' text/csv: schema: $ref: '#/components/schemas/BulkUpdateTagsResponse' description: '' x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/cancel/: post: operationId: insights_cancel_create description: 'DRF ViewSet mixin that gates coalesced responses behind permission checks. The QueryCoalescingMiddleware attaches cached response data to request.META["_coalesced_response"] for followers. This mixin runs DRF''s initial() (auth + permissions + throttling) before returning the cached response, ensuring the request is authorized.' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/generate_metadata/: post: operationId: insights_generate_metadata_create description: Generate an AI-suggested name and description for an insight based on its query configuration. parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:write responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/my_last_viewed/: get: operationId: insights_my_last_viewed_retrieve description: Returns basic details about the last 5 insights viewed by this user. Most recently viewed first. parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/trending/: get: operationId: insights_trending_retrieve description: 'Returns trending insights based on view count in the last N days (default 7). Defaults to returning top 10 insights.' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights responses: '200': description: No response body x-explicit-tags: - product_analytics /api/projects/{project_id}/insights/viewed/: post: operationId: insights_viewed_create description: 'Update insight view timestamps. Expects: {"insight_ids": [1, 2, 3, ...]}' parameters: - in: query name: format schema: type: string enum: - csv - json - $ref: '#/components/parameters/ProjectIdPath' tags: - insights requestBody: content: application/json: schema: $ref: '#/components/schemas/Insight' security: - PersonalAPIKeyAuth: - insight:read responses: '200': description: No response body x-explicit-tags: - product_analytics components: schemas: Response6: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response6 type: object RetentionFilter: additionalProperties: false properties: aggregationProperty: default: null description: The property to aggregate when aggregationType is sum or avg title: Aggregationproperty type: string nullable: true aggregationPropertyType: default: event description: The type of property to aggregate on (event or person). Defaults to event. allOf: - $ref: '#/components/schemas/AggregationPropertyType' nullable: true aggregationType: default: count description: The aggregation type to use for retention allOf: - $ref: '#/components/schemas/AggregationType' nullable: true cumulative: default: null title: Cumulative type: boolean nullable: true customAggregationTarget: default: null description: For data warehouse based retention insights when the aggregation target can't be mapped to persons or groups. title: Customaggregationtarget type: boolean nullable: true dashboardDisplay: default: null allOf: - $ref: '#/components/schemas/RetentionDashboardDisplayType' nullable: true display: default: null description: controls the display of the retention graph allOf: - $ref: '#/components/schemas/ChartDisplayType' nullable: true goalLines: default: null title: Goallines items: $ref: '#/components/schemas/GoalLine' type: array nullable: true meanRetentionCalculation: default: null allOf: - $ref: '#/components/schemas/MeanRetentionCalculation' nullable: true minimumOccurrences: default: null title: Minimumoccurrences type: integer nullable: true period: default: Day allOf: - $ref: '#/components/schemas/RetentionPeriod' nullable: true retentionCustomBrackets: default: null description: Custom brackets for retention calculations title: Retentioncustombrackets items: type: number type: array nullable: true retentionReference: default: null description: Whether retention is with regard to initial cohort size, or that of the previous period. allOf: - $ref: '#/components/schemas/RetentionReference' nullable: true retentionType: default: null allOf: - $ref: '#/components/schemas/RetentionType' nullable: true returningEntity: default: null allOf: - $ref: '#/components/schemas/RetentionEntity' nullable: true selectedInterval: default: null description: The selected interval to display across all cohorts (null = show all intervals for each cohort) title: Selectedinterval type: integer nullable: true showTrendLines: default: null title: Showtrendlines type: boolean nullable: true targetEntity: default: null allOf: - $ref: '#/components/schemas/RetentionEntity' nullable: true timeWindowMode: default: null description: The time window mode to use for retention calculations allOf: - $ref: '#/components/schemas/TimeWindowMode' nullable: true totalIntervals: default: 8 title: Totalintervals type: integer nullable: true title: RetentionFilter type: object LLMTrace: additionalProperties: false properties: aiSessionId: default: null title: Aisessionid type: string nullable: true createdAt: title: Createdat type: string distinctId: title: Distinctid type: string errorCount: default: null title: Errorcount type: number nullable: true events: items: $ref: '#/components/schemas/LLMTraceEvent' title: Events type: array id: title: Id type: string inputCost: default: null title: Inputcost type: number nullable: true inputState: default: null title: Inputstate nullable: true inputTokens: default: null title: Inputtokens type: number nullable: true isSupportTrace: default: null title: Issupporttrace type: boolean nullable: true outputCost: default: null title: Outputcost type: number nullable: true outputState: default: null title: Outputstate nullable: true outputTokens: default: null title: Outputtokens type: number nullable: true person: default: null allOf: - $ref: '#/components/schemas/LLMTracePerson' nullable: true requestCost: default: null title: Requestcost type: number nullable: true tools: default: null title: Tools items: type: string type: array nullable: true totalCost: default: null title: Totalcost type: number nullable: true totalLatency: default: null title: Totallatency type: number nullable: true traceName: default: null title: Tracename type: string nullable: true webSearchCost: default: null title: Websearchcost type: number nullable: true required: - createdAt - distinctId - events - id title: LLMTrace type: object RoleAtOrganizationEnum: enum: - engineering - data - product - founder - leadership - marketing - sales - other type: string description: '* `engineering` - Engineering * `data` - Data * `product` - Product Management * `founder` - Founder * `leadership` - Leadership * `marketing` - Marketing * `sales` - Sales / Success * `other` - Other' InsightThresholdType: enum: - absolute - percentage title: InsightThresholdType type: string ActorsQueryResponse: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: title: Limit type: integer missing_actors_count: default: null title: Missing Actors Count type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: title: Offset type: integer query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: type: string type: array nullable: true required: - columns - hogql - limit - offset - results title: ActorsQueryResponse type: object MaterializationType: enum: - materialized - inline - null title: MaterializationType EventsNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true event: default: null description: The event or `null` for all events. title: Event type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: EventsNode title: Kind type: string enum: - EventsNode limit: default: null title: Limit type: integer nullable: true math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: EventsNode type: object IsolationForestDetectorConfig: additionalProperties: false properties: n_estimators: default: null description: 'Number of trees in the forest (default: 100)' title: N Estimators type: integer nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: isolation_forest title: Type type: string enum: - isolation_forest window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: IsolationForestDetectorConfig type: object ErrorTrackingCorrelatedIssue: additionalProperties: false properties: assignee: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueAssignee' nullable: true cohort: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueCohort' nullable: true description: default: null title: Description type: string nullable: true event: title: Event type: string external_issues: default: null title: External Issues items: $ref: '#/components/schemas/ErrorTrackingExternalReference' type: array nullable: true first_seen: format: date-time title: First Seen type: string id: title: Id type: string last_seen: format: date-time title: Last Seen type: string library: default: null title: Library type: string nullable: true name: default: null title: Name type: string nullable: true odds_ratio: title: Odds Ratio type: number population: $ref: '#/components/schemas/Population' status: $ref: '#/components/schemas/ErrorTrackingIssueStatus' required: - event - first_seen - id - last_seen - odds_ratio - population - status title: ErrorTrackingCorrelatedIssue type: object ActorsQuery: additionalProperties: false properties: fixedProperties: default: null description: Currently only person filters supported. No filters for querying groups. See `filter_conditions()` in actor_strategies.py. title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' type: array nullable: true kind: default: ActorsQuery title: Kind type: string enum: - ActorsQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true orderBy: default: null title: Orderby items: type: string type: array nullable: true properties: default: null description: Currently only person filters supported. No filters for querying groups. See `filter_conditions()` in actor_strategies.py. title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilterValue' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true search: default: null title: Search type: string nullable: true select: default: null title: Select items: type: string type: array nullable: true source: default: null title: Source anyOf: - $ref: '#/components/schemas/InsightActorsQuery' - $ref: '#/components/schemas/FunnelsActorsQuery' - $ref: '#/components/schemas/FunnelCorrelationActorsQuery' - $ref: '#/components/schemas/ExperimentActorsQuery' - $ref: '#/components/schemas/StickinessActorsQuery' - $ref: '#/components/schemas/HogQLQuery' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: ActorsQuery type: object InsightActorsQuery: additionalProperties: false properties: breakdown: default: null title: Breakdown anyOf: - type: string - items: type: string type: array - type: integer nullable: true compare: default: null allOf: - $ref: '#/components/schemas/Compare' nullable: true day: default: null title: Day anyOf: - type: string - type: integer nullable: true includeRecordings: default: null title: Includerecordings type: boolean nullable: true interval: default: null description: An interval selected out of available intervals in source query. title: Interval type: integer nullable: true kind: default: InsightActorsQuery title: Kind type: string enum: - InsightActorsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true series: default: null title: Series type: integer nullable: true source: discriminator: mapping: FunnelsQuery: '#/components/schemas/FunnelsQuery' LifecycleQuery: '#/components/schemas/LifecycleQuery' PathsQuery: '#/components/schemas/PathsQuery' RetentionQuery: '#/components/schemas/RetentionQuery' StickinessQuery: '#/components/schemas/StickinessQuery' TrendsQuery: '#/components/schemas/TrendsQuery' WebOverviewQuery: '#/components/schemas/WebOverviewQuery' WebStatsTableQuery: '#/components/schemas/WebStatsTableQuery' propertyName: kind 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' - $ref: '#/components/schemas/WebStatsTableQuery' - $ref: '#/components/schemas/WebOverviewQuery' title: Source status: default: null title: Status type: string nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: InsightActorsQuery type: object FunnelStepReference: enum: - total - previous title: FunnelStepReference type: string Response25: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/LLMTrace' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response25 type: object CustomChannelRule: additionalProperties: false properties: channel_type: title: Channel Type type: string combiner: $ref: '#/components/schemas/FilterLogicalOperator' id: title: Id type: string items: items: $ref: '#/components/schemas/CustomChannelCondition' title: Items type: array required: - channel_type - combiner - id - items title: CustomChannelRule type: object ExperimentDataWarehouseNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true data_warehouse_join_key: title: Data Warehouse Join Key type: string events_join_key: title: Events Join Key type: string fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: ExperimentDataWarehouseNode title: Kind type: string enum: - ExperimentDataWarehouseNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - data_warehouse_join_key - events_join_key - table_name - timestamp_field title: ExperimentDataWarehouseNode type: object ErrorTrackingPendingFingerprintIssueStateUpdate: additionalProperties: false properties: assigned_role_id: default: null title: Assigned Role Id type: string nullable: true assigned_user_id: default: null title: Assigned User Id type: integer nullable: true fingerprint: title: Fingerprint type: string first_seen: description: ISO 8601 datetime string. title: First Seen type: string is_deleted: title: Is Deleted type: integer issue_description: default: null title: Issue Description type: string nullable: true issue_id: title: Issue Id type: string issue_name: default: null title: Issue Name type: string nullable: true issue_status: title: Issue Status type: string version: description: Client-stamped monotonic version (`Date.now()` ms at mutation success). title: Version type: integer required: - fingerprint - first_seen - is_deleted - issue_id - issue_status - version title: ErrorTrackingPendingFingerprintIssueStateUpdate type: object PropertyGroupFilterValue: additionalProperties: false properties: type: $ref: '#/components/schemas/FilterLogicalOperator' values: items: anyOf: - $ref: '#/components/schemas/PropertyGroupFilterValue' - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' title: Values type: array required: - type - values title: PropertyGroupFilterValue type: object SpanPropertyFilterType: enum: - span - span_attribute - span_resource_attribute title: SpanPropertyFilterType type: string EmptyPropertyFilter: additionalProperties: false properties: type: default: empty title: Type type: string enum: - empty title: EmptyPropertyFilter type: object SessionPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: session title: Type type: string enum: - session value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: SessionPropertyFilter type: object FunnelConversionWindowTimeUnit: enum: - second - minute - hour - day - week - month title: FunnelConversionWindowTimeUnit type: string ErrorTrackingExternalReference: additionalProperties: false properties: external_url: title: External Url type: string id: title: Id type: string integration: $ref: '#/components/schemas/ErrorTrackingExternalReferenceIntegration' required: - external_url - id - integration title: ErrorTrackingExternalReference type: object Response10: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - results - types title: Response10 type: object RevenueAnalyticsMRRQueryResultItem: additionalProperties: false properties: churn: title: Churn contraction: title: Contraction expansion: title: Expansion new: title: New total: title: Total required: - churn - contraction - expansion - new - total title: RevenueAnalyticsMRRQueryResultItem type: object InlineCohortCalculation: enum: - 'off' - auto - always title: InlineCohortCalculation type: string EnsembleDetectorConfig: additionalProperties: false properties: detectors: description: Sub-detector configurations (minimum 2) items: anyOf: - $ref: '#/components/schemas/ZScoreDetectorConfig' - $ref: '#/components/schemas/MADDetectorConfig' - $ref: '#/components/schemas/IQRDetectorConfig' - $ref: '#/components/schemas/ThresholdDetectorConfig' - $ref: '#/components/schemas/ECODDetectorConfig' - $ref: '#/components/schemas/COPODDetectorConfig' - $ref: '#/components/schemas/IsolationForestDetectorConfig' - $ref: '#/components/schemas/KNNDetectorConfig' - $ref: '#/components/schemas/HBOSDetectorConfig' - $ref: '#/components/schemas/LOFDetectorConfig' - $ref: '#/components/schemas/OCSVMDetectorConfig' - $ref: '#/components/schemas/PCADetectorConfig' title: Detectors type: array operator: description: How to combine sub-detector results allOf: - $ref: '#/components/schemas/EnsembleOperator' type: default: ensemble title: Type type: string enum: - ensemble required: - detectors - operator title: EnsembleDetectorConfig type: object SessionAttributionGroupBy: enum: - ChannelType - Medium - Source - Campaign - AdIds - ReferringDomain - InitialURL title: SessionAttributionGroupBy type: string ErrorTrackingExternalReferenceIntegration: additionalProperties: false properties: display_name: title: Display Name type: string id: title: Id type: number kind: $ref: '#/components/schemas/IntegrationKind' required: - display_name - id - kind title: ErrorTrackingExternalReferenceIntegration type: object ExperimentFunnelsQueryResponse: additionalProperties: false properties: credible_intervals: additionalProperties: items: type: number type: array title: Credible Intervals type: object expected_loss: title: Expected Loss type: number funnels_query: default: null allOf: - $ref: '#/components/schemas/FunnelsQuery' nullable: true insight: items: items: additionalProperties: true type: object type: array title: Insight type: array kind: default: ExperimentFunnelsQuery title: Kind type: string enum: - ExperimentFunnelsQuery probability: additionalProperties: type: number title: Probability type: object significance_code: $ref: '#/components/schemas/ExperimentSignificanceCode' significant: title: Significant type: boolean stats_version: default: null title: Stats Version type: integer nullable: true variants: items: $ref: '#/components/schemas/ExperimentVariantFunnelsBaseStats' title: Variants type: array required: - credible_intervals - expected_loss - insight - probability - significance_code - significant - variants title: ExperimentFunnelsQueryResponse type: object YAxisScaleType: enum: - log10 - linear title: YAxisScaleType type: string ResolvedDateRangeResponse: additionalProperties: false properties: date_from: format: date-time title: Date From type: string date_to: format: date-time title: Date To type: string required: - date_from - date_to title: ResolvedDateRangeResponse type: object ActionsNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: integer kind: default: ActionsNode title: Kind type: string enum: - ActionsNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - id title: ActionsNode type: object CompareFilter: additionalProperties: false properties: compare: default: false description: Whether to compare the current date range to a previous date range. title: Compare type: boolean nullable: true compare_to: default: null description: 'The date range to compare to. The value is a relative date. Examples of relative dates are: `-1y` for 1 year ago, `-14m` for 14 months ago, `-100w` for 100 weeks ago, `-14d` for 14 days ago, `-30h` for 30 hours ago.' title: Compare To type: string nullable: true title: CompareFilter type: object TrendsQueryResponse: additionalProperties: false properties: boxplot_data: default: null title: Boxplot Data items: $ref: '#/components/schemas/BoxPlotDatum' type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null description: Wether more breakdown values are available. title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: additionalProperties: true type: object title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: TrendsQueryResponse type: object ErrorTrackingOrderBy: enum: - last_seen - first_seen - occurrences - users - sessions title: ErrorTrackingOrderBy type: string Alert: type: object properties: id: type: string format: uuid readOnly: true created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true created_at: type: string format: date-time readOnly: true insight: type: integer description: 'Insight ID monitored by this alert. Note: Response returns full InsightBasicSerializer object.' name: type: string description: Human-readable name for the alert. subscribed_users: type: array items: type: integer description: 'User IDs to subscribe to this alert. Note: Response returns full UserBasicSerializer object.' threshold: allOf: - $ref: '#/components/schemas/Threshold' description: Threshold configuration with bounds and type for evaluating the alert. condition: allOf: - $ref: '#/components/schemas/AlertCondition' nullable: true description: 'Alert condition type. Determines how the value is evaluated: absolute_value, relative_increase, or relative_decrease.' state: type: string readOnly: true description: 'Current alert state: Firing, Not firing, Errored, or Snoozed.' enabled: type: boolean description: Whether the alert is actively being evaluated. last_notified_at: type: string format: date-time readOnly: true nullable: true last_checked_at: type: string format: date-time readOnly: true nullable: true next_check_at: type: string format: date-time readOnly: true nullable: true checks: type: array items: $ref: '#/components/schemas/AlertCheck' readOnly: true description: Alert check results. By default returns the last 5. Use checks_date_from and checks_date_to (e.g. '-24h', '-7d') to get checks within a time window, checks_limit to cap how many are returned (default 5, max 500), and checks_offset to skip the newest N checks for pagination (0-based). Newest checks first. Only populated on retrieve. checks_total: type: integer nullable: true readOnly: true description: Total alert checks matching the retrieve filters (date window). Only set on alert retrieve; omitted otherwise. config: allOf: - $ref: '#/components/schemas/TrendsAlertConfig' nullable: true description: Trends-specific alert configuration. Includes series_index (which series to monitor) and check_ongoing_interval (whether to check the current incomplete interval). detector_config: allOf: - $ref: '#/components/schemas/DetectorConfig' nullable: true calculation_interval: allOf: - $ref: '#/components/schemas/CalculationIntervalEnum' description: 'How often the alert is checked: hourly, daily, weekly, or monthly. * `hourly` - hourly * `daily` - daily * `weekly` - weekly * `monthly` - monthly' snoozed_until: type: string nullable: true description: Snooze the alert until this time. Pass a relative date string (e.g. '2h', '1d') or null to unsnooze. skip_weekend: type: boolean nullable: true description: Skip alert evaluation on weekends (Saturday and Sunday, local to project timezone). schedule_restriction: allOf: - $ref: '#/components/schemas/AlertScheduleRestriction' nullable: true description: 'Blocked local time windows (HH:MM in the project timezone). Interval is half-open [start, end): start inclusive, end exclusive. Use blocked_windows array of {start, end}. Null disables.' last_value: type: number format: double readOnly: true nullable: true description: The last calculated value from the most recent alert check. investigation_agent_enabled: type: boolean description: When enabled, an investigation agent runs on the state transition to firing and writes findings to a Notebook linked from the alert check. Only effective for detector-based (anomaly) alerts. investigation_gates_notifications: type: boolean description: When enabled (and investigation_agent_enabled is on), notification dispatch is held until the investigation agent produces a verdict. Notifications are suppressed when the verdict is false_positive (and optionally when inconclusive). A safety-net task force-fires after a few minutes if the investigation stalls. investigation_inconclusive_action: allOf: - $ref: '#/components/schemas/InvestigationInconclusiveActionEnum' description: 'How to handle an ''inconclusive'' verdict when notifications are gated. ''notify'' is the safe default — an agent that can''t be sure is itself useful signal. * `notify` - Notify * `suppress` - Suppress' required: - checks - checks_total - created_at - created_by - id - insight - last_checked_at - last_notified_at - last_value - next_check_at - state - subscribed_users - threshold ExperimentVariantResultFrequentist: additionalProperties: false properties: confidence_interval: default: null title: Confidence Interval items: type: number maxItems: 2 minItems: 2 type: array nullable: true covariate_sum: default: null title: Covariate Sum type: number nullable: true covariate_sum_product: default: null title: Covariate Sum Product type: number nullable: true covariate_sum_squares: default: null title: Covariate Sum Squares type: number nullable: true denominator_sum: default: null title: Denominator Sum type: number nullable: true denominator_sum_squares: default: null title: Denominator Sum Squares type: number nullable: true key: title: Key type: string method: default: frequentist title: Method type: string enum: - frequentist number_of_samples: title: Number Of Samples type: integer numerator_denominator_sum_product: default: null title: Numerator Denominator Sum Product type: number nullable: true p_value: default: null title: P Value type: number nullable: true significant: default: null title: Significant type: boolean nullable: true step_counts: default: null title: Step Counts items: type: integer type: array nullable: true step_sessions: default: null title: Step Sessions items: items: $ref: '#/components/schemas/SessionData' type: array type: array nullable: true sum: title: Sum type: number sum_squares: title: Sum Squares type: number validation_failures: default: null title: Validation Failures items: $ref: '#/components/schemas/ExperimentStatsValidationFailure' type: array nullable: true required: - key - number_of_samples - sum - sum_squares title: ExperimentVariantResultFrequentist type: object WebGoalsQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: WebGoalsQueryResponse type: object TracesQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/LLMTrace' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: TracesQueryResponse type: object CurrencyCode: enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTC - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LTL - LVL - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MTL - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW title: CurrencyCode type: string FunnelCorrelationResultsType: enum: - events - properties - event_with_properties title: FunnelCorrelationResultsType type: string ExperimentQueryResponse: additionalProperties: false properties: baseline: default: null allOf: - $ref: '#/components/schemas/ExperimentStatsBaseValidated' nullable: true breakdown_results: default: null description: Results grouped by breakdown value. When present, baseline and variant_results contain aggregated data. title: Breakdown Results items: $ref: '#/components/schemas/ExperimentBreakdownResult' type: array nullable: true clickhouse_sql: default: null title: Clickhouse Sql type: string nullable: true credible_intervals: default: null title: Credible Intervals additionalProperties: items: type: number type: array type: object nullable: true hogql: default: null title: Hogql type: string nullable: true insight: default: null title: Insight items: additionalProperties: true type: object type: array nullable: true is_precomputed: default: null description: Whether exposures were served from the precomputation system title: Is Precomputed type: boolean nullable: true kind: default: ExperimentQuery title: Kind type: string enum: - ExperimentQuery metric: default: null title: Metric anyOf: - $ref: '#/components/schemas/ExperimentMeanMetric' - $ref: '#/components/schemas/ExperimentFunnelMetric' - $ref: '#/components/schemas/ExperimentRatioMetric' - $ref: '#/components/schemas/ExperimentRetentionMetric' nullable: true p_value: default: null title: P Value type: number nullable: true probability: default: null title: Probability additionalProperties: type: number type: object nullable: true significance_code: default: null allOf: - $ref: '#/components/schemas/ExperimentSignificanceCode' nullable: true significant: default: null title: Significant type: boolean nullable: true stats_version: default: null title: Stats Version type: integer nullable: true variant_results: default: null title: Variant Results anyOf: - items: $ref: '#/components/schemas/ExperimentVariantResultFrequentist' type: array - items: $ref: '#/components/schemas/ExperimentVariantResultBayesian' type: array nullable: true variants: default: null title: Variants anyOf: - items: $ref: '#/components/schemas/ExperimentVariantTrendsBaseStats' type: array - items: $ref: '#/components/schemas/ExperimentVariantFunnelsBaseStats' type: array nullable: true title: ExperimentQueryResponse type: object PropertyGroupFilter: additionalProperties: false properties: type: $ref: '#/components/schemas/FilterLogicalOperator' values: items: $ref: '#/components/schemas/PropertyGroupFilterValue' title: Values type: array required: - type - values title: PropertyGroupFilter type: object RetentionDashboardDisplayType: enum: - table_only - graph_only - all title: RetentionDashboardDisplayType type: string AIEventType: enum: - $ai_generation - $ai_embedding - $ai_span - $ai_trace - $ai_metric - $ai_feedback - $ai_evaluation - $ai_tag - $ai_trace_summary - $ai_generation_summary - $ai_trace_clusters - $ai_generation_clusters title: AIEventType type: string TrendsAlertConfig: additionalProperties: false properties: check_ongoing_interval: default: null description: When true, evaluate the current (still incomplete) time interval in addition to completed ones. title: Check Ongoing Interval type: boolean nullable: true series_index: description: Zero-based index of the series in the insight's query to monitor. title: Series Index type: integer type: default: TrendsAlertConfig title: Type type: string enum: - TrendsAlertConfig required: - series_index title: TrendsAlertConfig type: object WebStatsTableQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true breakdownBy: $ref: '#/components/schemas/WebStatsBreakdown' compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeAvgTimeOnPage: default: null title: Includeavgtimeonpage type: boolean nullable: true includeBounceRate: default: null title: Includebouncerate type: boolean nullable: true includeHost: default: null title: Includehost type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true includeScrollDepth: default: null title: Includescrolldepth type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebStatsTableQuery title: Kind type: string enum: - WebStatsTableQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebStatsTableQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - breakdownBy - properties title: WebStatsTableQuery type: object HogQueryResponse: additionalProperties: false properties: bytecode: default: null title: Bytecode items: {} type: array nullable: true coloredBytecode: default: null title: Coloredbytecode items: {} type: array nullable: true results: title: Results stdout: default: null title: Stdout type: string nullable: true required: - results title: HogQueryResponse type: object DataWarehouseNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true distinct_id_field: title: Distinct Id Field type: string dw_source_type: default: null title: Dw Source Type type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: string id_field: title: Id Field type: string kind: default: DataWarehouseNode title: Kind type: string enum: - DataWarehouseNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - distinct_id_field - id - id_field - table_name - timestamp_field title: DataWarehouseNode type: object TaxonomicFilterGroupType: enum: - metadata - actions - cohorts - cohorts_with_all - data_warehouse - data_warehouse_properties - data_warehouse_person_properties - elements - events - internal_events - internal_event_properties - event_properties - event_feature_flags - event_metadata - numerical_event_properties - person_properties - pageview_urls - pageview_events - screens - screen_events - email_addresses - autocapture_events - custom_events - wildcard - groups - persons - feature_flags - insights - experiments - plugins - dashboards - name_groups - session_properties - hogql_expression - notebooks - log_entries - error_tracking_issues - logs - log_attributes - log_resource_attributes - spans - span_attributes - span_resource_attributes - replay - replay_saved_filters - revenue_analytics_properties - resources - error_tracking_properties - activity_log_properties - max_ai_context - workflow_variables - suggested_filters - recent_filters - pinned_filters - empty title: TaxonomicFilterGroupType type: string ChartSettingsFormatting: additionalProperties: false properties: decimalPlaces: default: null title: Decimalplaces type: number nullable: true prefix: default: null title: Prefix type: string nullable: true style: default: null allOf: - $ref: '#/components/schemas/Style' nullable: true suffix: default: null title: Suffix type: string nullable: true title: ChartSettingsFormatting type: object Population: additionalProperties: false properties: both: title: Both type: number exception_only: title: Exception Only type: number neither: title: Neither type: number success_only: title: Success Only type: number required: - both - exception_only - neither - success_only title: Population type: object FunnelCorrelationResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: $ref: '#/components/schemas/FunnelCorrelationResult' timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: FunnelCorrelationResponse type: object FlagPropertyFilter: additionalProperties: false properties: key: description: The key should be the flag ID title: Key type: string label: default: null title: Label type: string nullable: true operator: default: flag_evaluates_to description: Only flag_evaluates_to operator is allowed for flag dependencies title: Operator type: string enum: - flag_evaluates_to type: default: flag description: Feature flag dependency title: Type type: string enum: - flag value: anyOf: - type: boolean - type: string description: The value can be true, false, or a variant name title: Value required: - key - value title: FlagPropertyFilter type: object WebVitalsMetric: enum: - INP - LCP - CLS - FCP title: WebVitalsMetric type: string GroupsQueryResponse: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string kind: default: GroupsQuery title: Kind type: string enum: - GroupsQuery limit: title: Limit type: integer modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: title: Offset type: integer query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - limit - offset - results - types title: GroupsQueryResponse type: object SessionsQuery: additionalProperties: false properties: actionId: default: null description: Filter sessions by action - sessions that contain events matching this action title: Actionid type: integer nullable: true after: default: null description: Only fetch sessions that started after this timestamp title: After type: string nullable: true before: default: null description: Only fetch sessions that started before this timestamp title: Before type: string nullable: true event: default: null description: Filter sessions by event name - sessions that contain this event title: Event type: string nullable: true eventProperties: default: null description: Event property filters - filters sessions that contain events matching these properties title: Eventproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true filterTestAccounts: default: null description: Filter test accounts title: Filtertestaccounts type: boolean nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/PropertyGroupFilter' - $ref: '#/components/schemas/PropertyGroupFilterValue' - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: SessionsQuery title: Kind type: string enum: - SessionsQuery limit: default: null description: Number of rows to return title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null description: Number of rows to skip before returning rows title: Offset type: integer nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true personId: default: null description: Show sessions for a given person title: Personid type: string nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null allOf: - $ref: '#/components/schemas/SessionsQueryResponse' nullable: true select: description: Return a limited set of data. Required. items: type: string title: Select type: array tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true where: default: null description: HogQL filters to apply on returned data title: Where items: type: string type: array nullable: true required: - select title: SessionsQuery type: object PersonsOnEventsMode: enum: - disabled - person_id_no_override_properties_on_events - person_id_override_properties_on_events - person_id_override_properties_joined title: PersonsOnEventsMode type: string ErrorTrackingQuery: additionalProperties: false properties: assignee: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueAssignee' nullable: true dateRange: description: Date range to filter results. allOf: - $ref: '#/components/schemas/DateRange' filterGroup: default: null allOf: - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true filterTestAccounts: default: null description: Whether to filter out test accounts. title: Filtertestaccounts type: boolean nullable: true groupKey: default: null title: Groupkey type: string nullable: true groupTypeIndex: default: null title: Grouptypeindex type: integer nullable: true issueId: default: null description: Filter to a specific error tracking issue by ID. title: Issueid type: string nullable: true kind: default: ErrorTrackingQuery title: Kind type: string enum: - ErrorTrackingQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true orderBy: description: Field to sort results by. allOf: - $ref: '#/components/schemas/ErrorTrackingOrderBy' orderDirection: default: null description: Sort direction. allOf: - $ref: '#/components/schemas/OrderDirection2' nullable: true pendingFingerprintIssueStateUpdates: default: null description: Pending fingerprint issue state updates UNIONed into the fingerprint issue state subquery (V3 only). The backend caps the list at 50 entries; extras are dropped silently. title: Pendingfingerprintissuestateupdates items: $ref: '#/components/schemas/ErrorTrackingPendingFingerprintIssueStateUpdate' type: array nullable: true personId: default: null title: Personid type: string nullable: true response: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingQueryResponse' nullable: true searchQuery: default: null description: Free-text search across exception type, message, and stack frames. title: Searchquery type: string nullable: true status: default: null description: Filter by issue status. title: ErrorTrackingQueryStatus anyOf: - $ref: '#/components/schemas/ErrorTrackingIssueStatus' - type: string nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useQueryV2: default: null description: Use V2 query path (ClickHouse postgres connector join instead of separate Postgres queries) title: Usequeryv2 type: boolean nullable: true useQueryV3: default: null description: Use V3 query path (denormalized ClickHouse table, no Postgres joins) title: Usequeryv3 type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true volumeResolution: title: Volumeresolution type: integer withAggregations: default: null title: Withaggregations type: boolean nullable: true withFirstEvent: default: null title: Withfirstevent type: boolean nullable: true withLastEvent: default: null title: Withlastevent type: boolean nullable: true required: - dateRange - orderBy - volumeResolution title: ErrorTrackingQuery type: object Response1: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: title: Limit type: integer missing_actors_count: default: null title: Missing Actors Count type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: title: Offset type: integer query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: type: string type: array nullable: true required: - columns - hogql - limit - offset - results title: Response1 type: object StepOrderValue: enum: - strict - unordered - ordered title: StepOrderValue type: string Response16: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response16 type: object ZScoreDetectorConfig: additionalProperties: false properties: preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold [0-1]. Points above this probability are flagged (default: 0.9)' title: Threshold type: number nullable: true type: default: zscore title: Type type: string enum: - zscore window: default: null description: 'Rolling window size for calculating mean/std (default: 30)' title: Window type: integer nullable: true title: ZScoreDetectorConfig type: object CohortPropertyFilter: additionalProperties: false properties: cohort_name: default: null title: Cohort Name type: string nullable: true key: default: id title: Key type: string enum: - id label: default: null title: Label type: string nullable: true operator: default: in allOf: - $ref: '#/components/schemas/PropertyOperator' nullable: true type: default: cohort title: Type type: string enum: - cohort value: title: Value type: integer required: - value title: CohortPropertyFilter type: object RevenueAnalyticsOverviewItem: additionalProperties: false properties: key: $ref: '#/components/schemas/RevenueAnalyticsOverviewItemKey' value: title: Value type: number required: - key - value title: RevenueAnalyticsOverviewItem type: object ErrorTrackingIssueCorrelationQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/ErrorTrackingCorrelatedIssue' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: ErrorTrackingIssueCorrelationQueryResponse type: object PathType: enum: - $pageview - $screen - custom_event - hogql title: PathType type: string IntegrationKind: enum: - slack - slack-posthog-code - salesforce - hubspot - google-pubsub - google-cloud-service-account - google-cloud-storage - google-ads - google-sheets - linkedin-ads - snapchat - stripe - intercom - email - twilio - linear - github - gitlab - meta-ads - clickup - reddit-ads - databricks - tiktok-ads - bing-ads - vercel - azure-blob - firebase - jira - pinterest-ads - customerio-app - customerio-webhook - customerio-track title: IntegrationKind type: string LifecycleDataWarehouseNode: additionalProperties: false properties: aggregation_target_field: title: Aggregation Target Field type: string created_at_field: title: Created At Field type: string custom_name: default: null title: Custom Name type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: string kind: default: LifecycleDataWarehouseNode title: Kind type: string enum: - LifecycleDataWarehouseNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - aggregation_target_field - created_at_field - id - table_name - timestamp_field title: LifecycleDataWarehouseNode type: object QueryStatus: additionalProperties: false properties: complete: default: false description: Whether the query is still running. Will be true if the query is complete, even if it errored. Either result or error will be set. title: Complete type: boolean nullable: true dashboard_id: default: null title: Dashboard Id type: integer nullable: true end_time: default: null description: When did the query execution task finish (whether successfully or not). title: End Time format: date-time type: string nullable: true error: default: false description: If the query failed, this will be set to true. More information can be found in the error_message field. title: Error type: boolean nullable: true error_message: default: null title: Error Message type: string nullable: true expiration_time: default: null title: Expiration Time format: date-time type: string nullable: true id: title: Id type: string insight_id: default: null title: Insight Id type: integer nullable: true labels: default: null title: Labels items: type: string type: array nullable: true pickup_time: default: null description: When was the query execution task picked up by a worker. title: Pickup Time format: date-time type: string nullable: true query_async: default: true description: ONLY async queries use QueryStatus. title: Query Async type: boolean enum: - true query_progress: default: null allOf: - $ref: '#/components/schemas/ClickhouseQueryProgress' nullable: true results: default: null title: Results nullable: true start_time: default: null description: When was query execution task enqueued. title: Start Time format: date-time type: string nullable: true task_id: default: null title: Task Id type: string nullable: true team_id: title: Team Id type: integer required: - id - team_id title: QueryStatus type: object FeaturePropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: feature description: Event property with "$feature/" prepended title: Type type: string enum: - feature value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: FeaturePropertyFilter type: object MultipleBreakdownType: enum: - person - event - event_metadata - group - session - hogql - cohort - revenue_analytics - data_warehouse - data_warehouse_person_property title: MultipleBreakdownType type: string RevenueAnalyticsTopCustomersGroupBy: enum: - month - all title: RevenueAnalyticsTopCustomersGroupBy type: string DetectorConfig: anyOf: - $ref: '#/components/schemas/EnsembleDetectorConfig' - $ref: '#/components/schemas/ZScoreDetectorConfig' - $ref: '#/components/schemas/MADDetectorConfig' - $ref: '#/components/schemas/IQRDetectorConfig' - $ref: '#/components/schemas/ThresholdDetectorConfig' - $ref: '#/components/schemas/ECODDetectorConfig' - $ref: '#/components/schemas/COPODDetectorConfig' - $ref: '#/components/schemas/IsolationForestDetectorConfig' - $ref: '#/components/schemas/KNNDetectorConfig' - $ref: '#/components/schemas/HBOSDetectorConfig' - $ref: '#/components/schemas/LOFDetectorConfig' - $ref: '#/components/schemas/OCSVMDetectorConfig' - $ref: '#/components/schemas/PCADetectorConfig' description: Detector configuration types title: DetectorConfig UrlMatching: enum: - contains - exact - regex - null title: UrlMatching PersonPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: person description: Person properties title: Type type: string enum: - person value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: PersonPropertyFilter type: object ErrorTrackingIssueFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: error_tracking_issue title: Type type: string enum: - error_tracking_issue value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: ErrorTrackingIssueFilter type: object SimpleIntervalType: enum: - day - month title: SimpleIntervalType type: string ExperimentActorsQuery: additionalProperties: false properties: exposureConfig: default: null description: Exposure configuration for filtering events. Defines when users were first exposed to the experiment. title: Exposureconfig anyOf: - $ref: '#/components/schemas/ExperimentEventExposureConfig' - $ref: '#/components/schemas/ActionsNode' nullable: true featureFlagKey: default: null description: Feature flag key for breakdown filtering. title: Featureflagkey type: string nullable: true funnelStep: default: null description: Index of the step for which we want to get actors for, per experiment variant. Positive for converted persons, negative for dropped off persons. title: Funnelstep type: integer nullable: true funnelStepBreakdown: default: null description: The variant key for filtering actors. For experiments, this filters by feature flag variant (e.g., 'control', 'test'). title: Funnelstepbreakdown anyOf: - type: integer - type: string - type: number - items: anyOf: - type: integer - type: string - type: number type: array nullable: true includeRecordings: default: null title: Includerecordings type: boolean nullable: true kind: default: ExperimentActorsQuery title: Kind type: string enum: - ExperimentActorsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true multipleVariantHandling: default: null description: How to handle users with multiple variant exposures. allOf: - $ref: '#/components/schemas/MultipleVariantHandling' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true source: $ref: '#/components/schemas/ExperimentQuery' tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: ExperimentActorsQuery type: object RevenueExampleEventsQuery: additionalProperties: false properties: kind: default: RevenueExampleEventsQuery title: Kind type: string enum: - RevenueExampleEventsQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true response: default: null allOf: - $ref: '#/components/schemas/RevenueExampleEventsQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: RevenueExampleEventsQuery type: object PaginatedInsightList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Insight' ExperimentEventExposureConfig: additionalProperties: false properties: event: title: Event type: string kind: default: ExperimentEventExposureConfig title: Kind type: string enum: - ExperimentEventExposureConfig properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' title: Properties response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - event - properties title: ExperimentEventExposureConfig type: object TextMatching: enum: - contains - exact - regex - null title: TextMatching Compare: enum: - current - previous title: Compare type: string HogQLQueryModifiers: additionalProperties: false properties: bounceRateDurationSeconds: default: null title: Bounceratedurationseconds type: number nullable: true bounceRatePageViewMode: default: null allOf: - $ref: '#/components/schemas/BounceRatePageViewMode' nullable: true convertToProjectTimezone: default: null title: Converttoprojecttimezone type: boolean nullable: true customChannelTypeRules: default: null title: Customchanneltyperules items: $ref: '#/components/schemas/CustomChannelRule' type: array nullable: true dataWarehouseEventsModifiers: default: null title: Datawarehouseeventsmodifiers items: $ref: '#/components/schemas/DataWarehouseEventsModifier' type: array nullable: true debug: default: null title: Debug type: boolean nullable: true forceClickhouseDataSkippingIndexes: default: null description: If these are provided, the query will fail if these skip indexes are not used title: Forceclickhousedataskippingindexes items: type: string type: array nullable: true formatCsvAllowDoubleQuotes: default: null title: Formatcsvallowdoublequotes type: boolean nullable: true inCohortVia: default: null allOf: - $ref: '#/components/schemas/InCohortVia' nullable: true inlineCohortCalculation: default: null allOf: - $ref: '#/components/schemas/InlineCohortCalculation' nullable: true materializationMode: default: null allOf: - $ref: '#/components/schemas/MaterializationMode' nullable: true materializedColumnsOptimizationMode: default: null allOf: - $ref: '#/components/schemas/MaterializedColumnsOptimizationMode' nullable: true optimizeJoinedFilters: default: null title: Optimizejoinedfilters type: boolean nullable: true optimizeProjections: default: null title: Optimizeprojections type: boolean nullable: true personsArgMaxVersion: default: null allOf: - $ref: '#/components/schemas/PersonsArgMaxVersion' nullable: true personsJoinMode: default: null allOf: - $ref: '#/components/schemas/PersonsJoinMode' nullable: true personsOnEventsMode: default: null allOf: - $ref: '#/components/schemas/PersonsOnEventsMode' nullable: true propertyGroupsMode: default: null allOf: - $ref: '#/components/schemas/PropertyGroupsMode' nullable: true s3TableUseInvalidColumns: default: null title: S3Tableuseinvalidcolumns type: boolean nullable: true sessionIdPushdown: default: null description: Push a `session_id_v7 IN (SELECT … FROM events WHERE …)` predicate into the raw_sessions subquery to limit aggregation to sessions that participate in the outer events filter. title: Sessionidpushdown type: boolean nullable: true sessionTableVersion: default: null allOf: - $ref: '#/components/schemas/SessionTableVersion' nullable: true sessionsV2JoinMode: default: null allOf: - $ref: '#/components/schemas/SessionsV2JoinMode' nullable: true timings: default: null title: Timings type: boolean nullable: true useMaterializedViews: default: null title: Usematerializedviews type: boolean nullable: true usePreaggregatedIntermediateResults: default: null title: Usepreaggregatedintermediateresults type: boolean nullable: true usePreaggregatedTableTransforms: default: null description: Try to automatically convert HogQL queries to use preaggregated tables at the AST level * title: Usepreaggregatedtabletransforms type: boolean nullable: true useWebAnalyticsPreAggregatedTables: default: null title: Usewebanalyticspreaggregatedtables type: boolean nullable: true title: HogQLQueryModifiers type: object PathsLink: additionalProperties: false properties: average_conversion_time: title: Average Conversion Time type: number source: title: Source type: string target: title: Target type: string value: title: Value type: number required: - average_conversion_time - source - target - value title: PathsLink type: object WebOverviewItem: additionalProperties: false properties: changeFromPreviousPct: default: null title: Changefrompreviouspct type: number nullable: true isIncreaseBad: default: null title: Isincreasebad type: boolean nullable: true key: title: Key type: string kind: $ref: '#/components/schemas/WebAnalyticsItemKind' previous: default: null title: Previous type: number nullable: true usedPreAggregatedTables: default: null title: Usedpreaggregatedtables type: boolean nullable: true value: default: null title: Value type: number nullable: true required: - key - kind title: WebOverviewItem type: object TimeWindowMode: enum: - strict_calendar_dates - 24_hour_windows title: TimeWindowMode type: string Response18: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: $ref: '#/components/schemas/MarketingAnalyticsItem' type: array title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response18 type: object QueryLogTags: additionalProperties: false properties: name: default: null description: Name of the query, preferably unique. For example web_analytics_vitals title: Name type: string nullable: true productKey: default: null description: Product responsible for this query. Use string, there's no need to churn the Schema when we add a new product * title: Productkey type: string nullable: true scene: default: null description: Scene where this query is shown in the UI. Use string, there's no need to churn the Schema when we add a new Scene * title: Scene type: string nullable: true title: QueryLogTags type: object MarketingAnalyticsDrillDownLevel: enum: - channel - source - campaign - medium - content - term title: MarketingAnalyticsDrillDownLevel type: string PersonsJoinMode: enum: - inner - left title: PersonsJoinMode type: string InsightsThresholdBounds: additionalProperties: false properties: lower: default: null description: Alert fires when the value drops below this number. title: Lower type: number nullable: true upper: default: null description: Alert fires when the value exceeds this number. title: Upper type: number nullable: true title: InsightsThresholdBounds type: object StickinessFilter: additionalProperties: false properties: computedAs: default: null allOf: - $ref: '#/components/schemas/StickinessComputationMode' nullable: true display: default: null allOf: - $ref: '#/components/schemas/ChartDisplayType' nullable: true hiddenLegendIndexes: default: null title: Hiddenlegendindexes items: type: integer type: array nullable: true resultCustomizationBy: default: value description: Whether result datasets are associated by their values or by their order. allOf: - $ref: '#/components/schemas/ResultCustomizationBy' nullable: true resultCustomizations: default: null description: Customizations for the appearance of result datasets. title: Resultcustomizations anyOf: - additionalProperties: $ref: '#/components/schemas/ResultCustomizationByValue' type: object - additionalProperties: $ref: '#/components/schemas/ResultCustomizationByPosition' type: object nullable: true showLegend: default: null title: Showlegend type: boolean nullable: true showMultipleYAxes: default: null title: Showmultipleyaxes type: boolean nullable: true showValuesOnSeries: default: null title: Showvaluesonseries type: boolean nullable: true stickinessCriteria: default: null allOf: - $ref: '#/components/schemas/StickinessCriteria' nullable: true title: StickinessFilter type: object HogQLPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true type: default: hogql title: Type type: string enum: - hogql value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key title: HogQLPropertyFilter type: object SessionsQueryResponse: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - results - types title: SessionsQueryResponse type: object RevenueAnalyticsGrossRevenueQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RevenueAnalyticsGrossRevenueQueryResponse type: object ThresholdDetectorConfig: additionalProperties: false properties: lower_bound: default: null description: Lower bound - values below this are anomalies title: Lower Bound type: number nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true type: default: threshold title: Type type: string enum: - threshold upper_bound: default: null description: Upper bound - values above this are anomalies title: Upper Bound type: number nullable: true title: ThresholdDetectorConfig type: object MADDetectorConfig: additionalProperties: false properties: preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold [0-1]. Points above this probability are flagged (default: 0.9)' title: Threshold type: number nullable: true type: default: mad title: Type type: string enum: - mad window: default: null description: 'Rolling window size for calculating median/MAD (default: 30)' title: Window type: integer nullable: true title: MADDetectorConfig type: object ExperimentMetricGoal: enum: - increase - decrease title: ExperimentMetricGoal type: string EffectivePrivilegeLevelEnum: enum: - 21 - 37 type: integer WebOverviewQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebOverviewQuery title: Kind type: string enum: - WebOverviewQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebOverviewQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: WebOverviewQuery type: object InCohortVia: enum: - auto - leftjoin - subquery - leftjoin_conjoined title: InCohortVia type: string Response26: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response26 type: object BounceRatePageViewMode: enum: - count_pageviews - uniq_urls - uniq_page_screen_autocaptures title: BounceRatePageViewMode type: string PathsQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/PathsLink' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: PathsQueryResponse type: object WebVitalsPercentile: enum: - p75 - p90 - p99 title: WebVitalsPercentile type: string RevenueExampleDataWarehouseTablesQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: RevenueExampleDataWarehouseTablesQueryResponse type: object RevenueAnalyticsPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: revenue_analytics title: Type type: string enum: - revenue_analytics value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: RevenueAnalyticsPropertyFilter type: object FirstEvent: additionalProperties: false properties: distinct_id: title: Distinct Id type: string properties: type: string title: Properties timestamp: title: Timestamp type: string uuid: title: Uuid type: string required: - distinct_id - properties - timestamp - uuid title: FirstEvent type: object WebExternalClicksTableQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: WebExternalClicksTableQueryResponse type: object Key10: enum: - tag_name - text - href - selector title: Key10 type: string RevenueAnalyticsTopCustomersQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RevenueAnalyticsTopCustomersQueryResponse type: object DurationType: enum: - duration - active_seconds - inactive_seconds title: DurationType type: string Response3: additionalProperties: false properties: clickhouse: default: null description: Executed ClickHouse query title: Clickhouse type: string nullable: true columns: default: null description: Returned columns title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true explain: default: null description: Query explanation output title: Explain items: type: string type: array nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true metadata: default: null description: Query metadata output allOf: - $ref: '#/components/schemas/HogQLMetadataResponse' nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query: default: null description: Input query string title: Query type: string nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null description: Types of returned columns title: Types items: {} type: array nullable: true required: - results title: Response3 type: object Threshold: type: object properties: id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true name: type: string description: Optional name for the threshold. configuration: allOf: - $ref: '#/components/schemas/InsightThreshold' description: Threshold bounds and type. Includes bounds (lower/upper floats) and type (absolute or percentage). required: - configuration - created_at - id PathsQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation title: Aggregation Group Type Index type: integer nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true funnelPathsFilter: default: null description: Used for displaying paths in relation to funnel steps. allOf: - $ref: '#/components/schemas/FunnelPathsFilter' nullable: true kind: default: PathsQuery title: Kind type: string enum: - PathsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true pathsFilter: description: Properties specific to the paths insight allOf: - $ref: '#/components/schemas/PathsFilter' properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/PathsQueryResponse' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - pathsFilter title: PathsQuery type: object RetentionPeriod: enum: - Hour - Day - Week - Month title: RetentionPeriod type: string GoalLine: additionalProperties: false properties: borderColor: default: null title: Bordercolor type: string nullable: true displayIfCrossed: default: null title: Displayifcrossed type: boolean nullable: true displayLabel: default: null title: Displaylabel type: boolean nullable: true label: title: Label type: string position: default: null allOf: - $ref: '#/components/schemas/Position' nullable: true value: title: Value type: number required: - label - value title: GoalLine type: object COPODDetectorConfig: additionalProperties: false properties: preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: copod title: Type type: string enum: - copod window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: COPODDetectorConfig type: object EntityType: enum: - actions - events - data_warehouse - new_entity - groups title: EntityType type: string MaterializedColumnsOptimizationMode: enum: - disabled - optimized title: MaterializedColumnsOptimizationMode type: string QueryTiming: additionalProperties: false properties: k: description: Key. Shortened to 'k' to save on data. title: K type: string t: description: Time in seconds. Shortened to 't' to save on data. title: T type: number required: - k - t title: QueryTiming type: object ExperimentSignificanceCode: enum: - significant - not_enough_exposure - low_win_probability - high_loss - high_p_value title: ExperimentSignificanceCode type: string ResultCustomizationByValue: additionalProperties: false properties: assignmentBy: default: value title: Assignmentby type: string enum: - value color: default: null allOf: - $ref: '#/components/schemas/DataColorToken' nullable: true hidden: default: null title: Hidden type: boolean nullable: true title: ResultCustomizationByValue type: object ErrorTrackingQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/ErrorTrackingIssue' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: ErrorTrackingQueryResponse type: object DataColorToken: enum: - preset-1 - preset-2 - preset-3 - preset-4 - preset-5 - preset-6 - preset-7 - preset-8 - preset-9 - preset-10 - preset-11 - preset-12 - preset-13 - preset-14 - preset-15 title: DataColorToken type: string GradientScaleMode: enum: - absolute - relative title: GradientScaleMode type: string Position: enum: - start - end title: Position type: string Response2: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string kind: default: GroupsQuery title: Kind type: string enum: - GroupsQuery limit: title: Limit type: integer modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: title: Offset type: integer query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - limit - offset - results - types title: Response2 type: object CalendarHeatmapMathType: enum: - total - dau title: CalendarHeatmapMathType type: string RevenueCurrencyPropertyConfig: additionalProperties: false properties: property: default: null title: Property type: string nullable: true static: default: null allOf: - $ref: '#/components/schemas/CurrencyCode' nullable: true title: RevenueCurrencyPropertyConfig type: object ResultCustomizationBy: enum: - value - position title: ResultCustomizationBy type: string AlertScheduleRestrictionWindow: additionalProperties: false properties: start: description: Start time HH:MM (24-hour, project timezone). Inclusive. Each window must span ≥ 30 minutes on the local daily timeline (half-open [start, end)). title: Start type: string end: description: End time HH:MM (24-hour). Exclusive (half-open interval). Each window must span ≥ 30 minutes locally. title: End type: string required: - start - end title: AlertScheduleRestrictionWindow type: object LifecycleQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation title: Aggregation Group Type Index type: integer nullable: true customAggregationTarget: default: null description: For data warehouse based lifecycle insights when the aggregation target can't be mapped to persons or groups. title: Customaggregationtarget type: boolean nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true interval: default: day description: Granularity of the response. Can be one of `hour`, `day`, `week` or `month` allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: LifecycleQuery title: Kind type: string enum: - LifecycleQuery lifecycleFilter: default: null description: Properties specific to the lifecycle insight allOf: - $ref: '#/components/schemas/LifecycleFilter' nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/LifecycleQueryResponse' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true series: description: Events and actions to include items: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/LifecycleDataWarehouseNode' title: Series type: array tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - series title: LifecycleQuery type: object RetentionResult: additionalProperties: false properties: breakdown_value: default: null description: Optional breakdown value for retention cohorts title: Breakdown Value anyOf: - type: string - type: number nullable: true date: format: date-time title: Date type: string label: title: Label type: string values: items: $ref: '#/components/schemas/RetentionValue' title: Values type: array required: - date - label - values title: RetentionResult type: object RevenueExampleEventsQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: RevenueExampleEventsQueryResponse type: object Scale: enum: - linear - logarithmic title: Scale type: string Response13: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/RevenueAnalyticsMRRQueryResultItem' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response13 type: object StickinessCriteria: additionalProperties: false properties: operator: $ref: '#/components/schemas/StickinessOperator' value: minimum: 1 title: Value type: integer required: - operator - value title: StickinessCriteria type: object BulkUpdateTagsError: type: object properties: id: type: integer reason: type: string required: - id - reason LogPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: $ref: '#/components/schemas/LogPropertyFilterType' value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator - type title: LogPropertyFilter type: object EventsQueryActionStep: additionalProperties: false properties: event: default: null title: Event type: string nullable: true href: default: null title: Href type: string nullable: true href_matching: default: null allOf: - $ref: '#/components/schemas/HrefMatching' nullable: true properties: default: null title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true selector: default: null title: Selector type: string nullable: true tag_name: default: null title: Tag Name type: string nullable: true text: default: null title: Text type: string nullable: true text_matching: default: null allOf: - $ref: '#/components/schemas/TextMatching' nullable: true url: default: null title: Url type: string nullable: true url_matching: default: null allOf: - $ref: '#/components/schemas/UrlMatching' nullable: true title: EventsQueryActionStep type: object ErrorTrackingIssue: additionalProperties: false properties: aggregations: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueAggregations' nullable: true assignee: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueAssignee' nullable: true cohort: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueCohort' nullable: true description: default: null title: Description type: string nullable: true external_issues: default: null title: External Issues items: $ref: '#/components/schemas/ErrorTrackingExternalReference' type: array nullable: true first_event: default: null allOf: - $ref: '#/components/schemas/FirstEvent' nullable: true first_seen: format: date-time title: First Seen type: string function: default: null title: Function type: string nullable: true id: title: Id type: string last_event: default: null allOf: - $ref: '#/components/schemas/LastEvent' nullable: true last_seen: format: date-time title: Last Seen type: string library: default: null title: Library type: string nullable: true name: default: null title: Name type: string nullable: true source: default: null title: Source type: string nullable: true status: $ref: '#/components/schemas/ErrorTrackingIssueStatus' required: - first_seen - id - last_seen - status title: ErrorTrackingIssue type: object ConversionGoalFilter1: additionalProperties: false properties: conversion_goal_id: title: Conversion Goal Id type: string conversion_goal_name: title: Conversion Goal Name type: string custom_name: default: null title: Custom Name type: string nullable: true event: default: null description: The event or `null` for all events. title: Event type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: EventsNode title: Kind type: string enum: - EventsNode limit: default: null title: Limit type: integer nullable: true math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true schema_map: additionalProperties: anyOf: - type: string - {} title: Schema Map type: object version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - conversion_goal_id - conversion_goal_name - schema_map title: ConversionGoalFilter1 type: object CustomChannelOperator: enum: - exact - is_not - is_set - is_not_set - icontains - not_icontains - regex - not_regex title: CustomChannelOperator type: string StickinessActorsQuery: additionalProperties: false properties: compare: default: null allOf: - $ref: '#/components/schemas/Compare' nullable: true day: default: null title: Day anyOf: - type: string - type: integer nullable: true includeRecordings: default: null title: Includerecordings type: boolean nullable: true kind: default: StickinessActorsQuery title: Kind type: string enum: - StickinessActorsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true operator: default: null allOf: - $ref: '#/components/schemas/StickinessOperator' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true series: default: null title: Series type: integer nullable: true source: $ref: '#/components/schemas/StickinessQuery' tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: StickinessActorsQuery type: object GroupNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: GroupNode title: Kind type: string enum: - GroupNode limit: default: null title: Limit type: integer nullable: true math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true nodes: description: Entities to combine in this group items: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/DataWarehouseNode' title: Nodes type: array operator: description: Group of entities combined with AND/OR operator allOf: - $ref: '#/components/schemas/FilterLogicalOperator' optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - nodes - operator title: GroupNode type: object Response12: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response12 type: object Insight: type: object description: Simplified serializer to speed response times when loading large amounts of objects. properties: id: type: integer readOnly: true short_id: type: string readOnly: true name: type: string nullable: true maxLength: 400 derived_name: type: string nullable: true maxLength: 400 query: allOf: - $ref: '#/components/schemas/_InsightQuerySchema' nullable: true order: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true deleted: type: boolean 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 " 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_refresh: type: string format: date-time nullable: true 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 " cache_target_age: type: string format: date-time nullable: true readOnly: true description: The target age of the cached results for this insight. next_allowed_client_refresh: type: string format: date-time nullable: true 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 " result: readOnly: true hasMore: type: boolean nullable: true readOnly: true columns: type: array items: type: string nullable: true readOnly: true created_at: type: string format: date-time readOnly: true nullable: true created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true description: type: string nullable: true maxLength: 400 updated_at: type: string format: date-time readOnly: true tags: type: array items: {} favorited: type: boolean last_modified_at: type: string format: date-time readOnly: true last_modified_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true is_sample: type: boolean readOnly: true effective_restriction_level: allOf: - $ref: '#/components/schemas/EffectivePrivilegeLevelEnum' readOnly: true effective_privilege_level: allOf: - $ref: '#/components/schemas/EffectivePrivilegeLevelEnum' readOnly: true user_access_level: type: string nullable: true readOnly: true description: The effective access level the user has for this object timezone: type: string nullable: true readOnly: true description: The timezone this chart is displayed in. is_cached: type: boolean readOnly: true query_status: readOnly: true hogql: type: string nullable: true readOnly: true types: type: array items: {} nullable: true readOnly: true resolved_date_range: type: object nullable: true properties: date_from: type: string format: date-time date_to: type: string format: date-time readOnly: true _create_in_folder: type: string writeOnly: true title: ' create in folder' alerts: type: array items: {} readOnly: true last_viewed_at: type: string format: date-time nullable: true readOnly: true required: - alerts - cache_target_age - columns - created_at - created_by - dashboard_tiles - effective_privilege_level - effective_restriction_level - hasMore - hogql - id - is_cached - is_sample - last_modified_at - last_modified_by - last_refresh - last_viewed_at - next_allowed_client_refresh - query_status - resolved_date_range - result - short_id - timezone - types - updated_at - user_access_level ConditionalFormattingRule: additionalProperties: false properties: bytecode: items: {} title: Bytecode type: array color: title: Color type: string colorMode: default: null allOf: - $ref: '#/components/schemas/ColorMode' nullable: true columnName: title: Columnname type: string id: title: Id type: string input: title: Input type: string templateId: title: Templateid type: string required: - bytecode - color - columnName - id - input - templateId title: ConditionalFormattingRule type: object SessionsV2JoinMode: enum: - string - uuid title: SessionsV2JoinMode type: string InsightVizNode: additionalProperties: false properties: embedded: default: null description: Query is embedded inside another bordered component title: Embedded type: boolean nullable: true full: default: null description: Show with most visual options enabled. Used in insight scene. title: Full type: boolean nullable: true hidePersonsModal: default: null title: Hidepersonsmodal type: boolean nullable: true hideTooltipOnScroll: default: null title: Hidetooltiponscroll type: boolean nullable: true kind: default: InsightVizNode title: Kind type: string enum: - InsightVizNode showCorrelationTable: default: null title: Showcorrelationtable type: boolean nullable: true showFilters: default: null title: Showfilters type: boolean nullable: true showHeader: default: null title: Showheader type: boolean nullable: true showLastComputation: default: null title: Showlastcomputation type: boolean nullable: true showLastComputationRefresh: default: null title: Showlastcomputationrefresh type: boolean nullable: true showResults: default: null title: Showresults type: boolean nullable: true showTable: default: null title: Showtable type: boolean nullable: true source: discriminator: mapping: FunnelsQuery: '#/components/schemas/FunnelsQuery' LifecycleQuery: '#/components/schemas/LifecycleQuery' PathsQuery: '#/components/schemas/PathsQuery' RetentionQuery: '#/components/schemas/RetentionQuery' StickinessQuery: '#/components/schemas/StickinessQuery' TrendsQuery: '#/components/schemas/TrendsQuery' WebOverviewQuery: '#/components/schemas/WebOverviewQuery' WebStatsTableQuery: '#/components/schemas/WebStatsTableQuery' propertyName: kind 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' - $ref: '#/components/schemas/WebStatsTableQuery' - $ref: '#/components/schemas/WebOverviewQuery' title: Source suppressSessionAnalysisWarning: default: null title: Suppresssessionanalysiswarning type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true vizSpecificOptions: default: null allOf: - $ref: '#/components/schemas/VizSpecificOptions' nullable: true required: - source title: InsightVizNode type: object ChartDisplayType: enum: - Auto - ActionsLineGraph - ActionsBar - ActionsUnstackedBar - ActionsStackedBar - ActionsAreaGraph - ActionsLineGraphCumulative - BoldNumber - ActionsPie - ActionsBarValue - ActionsTable - WorldMap - CalendarHeatmap - TwoDimensionalHeatmap - BoxPlot title: ChartDisplayType type: string RevenueAnalyticsTopCustomersQuery: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true groupBy: $ref: '#/components/schemas/RevenueAnalyticsTopCustomersGroupBy' kind: default: RevenueAnalyticsTopCustomersQuery title: Kind type: string enum: - RevenueAnalyticsTopCustomersQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/RevenueAnalyticsTopCustomersQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - groupBy - properties title: RevenueAnalyticsTopCustomersQuery type: object EndpointsUsageOrderByDirection: enum: - ASC - DESC title: EndpointsUsageOrderByDirection type: string RetentionReference: enum: - total - previous title: RetentionReference type: string BaseMathType: enum: - total - dau - weekly_active - monthly_active - unique_session - first_time_for_user - first_matching_event_for_user title: BaseMathType type: string HogQLFilters: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true properties: default: null title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true title: HogQLFilters type: object PCADetectorConfig: additionalProperties: false properties: preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: pca title: Type type: string enum: - pca window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: PCADetectorConfig type: object WebVitalsPathBreakdownQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/WebVitalsPathBreakdownResult' maxItems: 1 minItems: 1 title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: WebVitalsPathBreakdownQueryResponse type: object FunnelExclusionActionsNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true funnelFromStep: title: Funnelfromstep type: integer funnelToStep: title: Funneltostep type: integer id: title: Id type: integer kind: default: ActionsNode title: Kind type: string enum: - ActionsNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - funnelFromStep - funnelToStep - id title: FunnelExclusionActionsNode type: object ExperimentBreakdownResult: additionalProperties: false properties: baseline: description: Control variant stats for this breakdown allOf: - $ref: '#/components/schemas/ExperimentStatsBaseValidated' breakdown_value: description: The breakdown values as an array (e.g., ["MacOS", "Chrome"] for multi-breakdown, ["Chrome"] for single) Although `BreakdownKeyType` could be an array, we only use the array form for the breakdown_value. The way `BreakdownKeyType` is defined is problematic. It should be treated as a primitive and allow for the types using it to define if it's and array or an optional value. items: anyOf: - type: string - type: number - type: integer title: Breakdown Value type: array variants: anyOf: - items: $ref: '#/components/schemas/ExperimentVariantResultFrequentist' type: array - items: $ref: '#/components/schemas/ExperimentVariantResultBayesian' type: array description: Test variant results with statistical comparisons for this breakdown title: Variants required: - baseline - breakdown_value - variants title: ExperimentBreakdownResult type: object SpanPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: $ref: '#/components/schemas/SpanPropertyFilterType' value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator - type title: SpanPropertyFilter type: object PathCleaningFilter: additionalProperties: false properties: alias: default: null title: Alias type: string nullable: true order: default: null title: Order type: number nullable: true regex: default: null title: Regex type: string nullable: true title: PathCleaningFilter type: object SessionAttributionExplorerQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: SessionAttributionExplorerQueryResponse type: object BoxPlotDatum: additionalProperties: false properties: day: title: Day type: string label: title: Label type: string max: title: Max type: number mean: title: Mean type: number median: title: Median type: number min: title: Min type: number p25: title: P25 type: number p75: title: P75 type: number series_index: default: null title: Series Index type: integer nullable: true series_label: default: null title: Series Label type: string nullable: true required: - day - label - max - mean - median - min - p25 - p75 title: BoxPlotDatum type: object TraceQuery: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true kind: default: TraceQuery title: Kind type: string enum: - TraceQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null allOf: - $ref: '#/components/schemas/TraceQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true traceId: title: Traceid type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - traceId title: TraceQuery type: object HrefMatching: enum: - contains - exact - regex - null title: HrefMatching AlertScheduleRestriction: additionalProperties: false properties: blocked_windows: description: Blocked local time windows when the alert must not run. Overlapping or identical windows are merged when saved. At most five windows before normalization; empty array clears quiet hours. items: $ref: '#/components/schemas/AlertScheduleRestrictionWindow' title: Blocked Windows type: array required: - blocked_windows title: AlertScheduleRestriction type: object TracesQuery: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterSupportTraces: default: null title: Filtersupporttraces type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true groupKey: default: null title: Groupkey type: string nullable: true groupTypeIndex: default: null title: Grouptypeindex type: integer nullable: true kind: default: TracesQuery title: Kind type: string enum: - TracesQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true personId: default: null description: Person who performed the event title: Personid type: string nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true randomOrder: default: null description: Use random ordering instead of timestamp DESC. Useful for representative sampling to avoid recency bias. title: Randomorder type: boolean nullable: true response: default: null allOf: - $ref: '#/components/schemas/TracesQueryResponse' nullable: true showColumnConfigurator: default: null title: Showcolumnconfigurator type: boolean nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: TracesQuery type: object ChartAxis: additionalProperties: false properties: column: title: Column type: string settings: default: null allOf: - $ref: '#/components/schemas/Settings' nullable: true required: - column title: ChartAxis type: object YAxisPosition: enum: - left - right title: YAxisPosition type: string StickinessOperator: enum: - gte - lte - exact title: StickinessOperator type: string DataWarehousePersonPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: data_warehouse_person_property title: Type type: string enum: - data_warehouse_person_property value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: DataWarehousePersonPropertyFilter type: object PropertyMathType: enum: - avg - sum - min - max - median - p75 - p90 - p95 - p99 title: PropertyMathType type: string HeatmapGradientStop: additionalProperties: false properties: color: title: Color type: string value: title: Value type: number required: - color - value title: HeatmapGradientStop type: object LifecycleToggle: enum: - new - resurrecting - returning - dormant title: LifecycleToggle type: string EventsQueryResponse: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true nextCursor: default: null description: Cursor for fetching the next page of results title: Nextcursor type: string nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - results - types title: EventsQueryResponse type: object TrendsQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation title: Aggregation Group Type Index type: integer nullable: true breakdownFilter: default: null description: Breakdown of the events and actions allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true compareFilter: default: null description: Compare to date range allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null description: Whether we should be comparing against a specific conversion goal title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true interval: default: day description: Granularity of the response. Can be one of `hour`, `day`, `week` or `month` allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: TrendsQuery title: Kind type: string enum: - TrendsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/TrendsQueryResponse' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true series: description: Events and actions to include items: anyOf: - $ref: '#/components/schemas/GroupNode' - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/DataWarehouseNode' title: Series type: array tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true trendsFilter: default: null description: Properties specific to the trends insight allOf: - $ref: '#/components/schemas/TrendsFilter' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - series title: TrendsQuery type: object WebVitalsPathBreakdownResult: additionalProperties: false properties: good: items: $ref: '#/components/schemas/WebVitalsPathBreakdownResultItem' title: Good type: array needs_improvements: items: $ref: '#/components/schemas/WebVitalsPathBreakdownResultItem' title: Needs Improvements type: array poor: items: $ref: '#/components/schemas/WebVitalsPathBreakdownResultItem' title: Poor type: array required: - good - needs_improvements - poor title: WebVitalsPathBreakdownResult type: object FunnelVizType: enum: - steps - time_to_convert - trends - flow title: FunnelVizType type: string StickinessQuery: additionalProperties: false properties: compareFilter: default: null description: Compare to date range allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true interval: default: day description: Granularity of the response. Can be one of `hour`, `day`, `week` or `month` allOf: - $ref: '#/components/schemas/IntervalType' nullable: true intervalCount: default: null description: How many intervals comprise a period. Only used for cohorts, otherwise default 1. title: Intervalcount minimum: 1 type: integer nullable: true kind: default: StickinessQuery title: Kind type: string enum: - StickinessQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/StickinessQueryResponse' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true series: description: Events and actions to include items: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/DataWarehouseNode' title: Series type: array stickinessFilter: default: null description: Properties specific to the stickiness insight allOf: - $ref: '#/components/schemas/StickinessFilter' nullable: true tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - series title: StickinessQuery type: object WebAnalyticsSampling: additionalProperties: false properties: enabled: default: null title: Enabled type: boolean nullable: true forceSamplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true title: WebAnalyticsSampling type: object EventsQuery: additionalProperties: false properties: actionId: default: null description: Show events matching a given action title: Actionid type: integer nullable: true actionSteps: default: null description: Show events matching action steps directly, used when no actionId is provided (e.g. previewing unsaved actions). Ignored if actionId is set. title: Actionsteps items: $ref: '#/components/schemas/EventsQueryActionStep' type: array nullable: true after: default: null description: Only fetch events that happened after this timestamp title: After type: string nullable: true before: default: null description: Only fetch events that happened before this timestamp title: Before type: string nullable: true event: default: null description: Limit to events matching this string title: Event type: string nullable: true events: default: null description: Filter to events matching any of these event names title: Events items: type: string type: array nullable: true filterTestAccounts: default: null description: Filter test accounts title: Filtertestaccounts type: boolean nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/PropertyGroupFilter' - $ref: '#/components/schemas/PropertyGroupFilterValue' - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: EventsQuery title: Kind type: string enum: - EventsQuery limit: default: null description: Number of rows to return title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null description: Number of rows to skip before returning rows title: Offset type: integer nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true personId: default: null description: Show events for a given person title: Personid type: string nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null allOf: - $ref: '#/components/schemas/EventsQueryResponse' nullable: true select: description: Return a limited set of data. Required. items: type: string title: Select type: array source: default: null description: source for querying events for insights allOf: - $ref: '#/components/schemas/InsightActorsQuery' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true where: default: null description: HogQL filters to apply on returned data title: Where items: type: string type: array nullable: true required: - select title: EventsQuery type: object RetentionType: enum: - retention_recurring - retention_first_time - retention_first_ever_occurrence title: RetentionType type: string NonIntegratedConversionsTableQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: $ref: '#/components/schemas/MarketingAnalyticsItem' type: array title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: NonIntegratedConversionsTableQueryResponse type: object ExperimentStatsBaseValidated: additionalProperties: false properties: covariate_sum: default: null title: Covariate Sum type: number nullable: true covariate_sum_product: default: null title: Covariate Sum Product type: number nullable: true covariate_sum_squares: default: null title: Covariate Sum Squares type: number nullable: true denominator_sum: default: null title: Denominator Sum type: number nullable: true denominator_sum_squares: default: null title: Denominator Sum Squares type: number nullable: true key: title: Key type: string number_of_samples: title: Number Of Samples type: integer numerator_denominator_sum_product: default: null title: Numerator Denominator Sum Product type: number nullable: true step_counts: default: null title: Step Counts items: type: integer type: array nullable: true step_sessions: default: null title: Step Sessions items: items: $ref: '#/components/schemas/SessionData' type: array type: array nullable: true sum: title: Sum type: number sum_squares: title: Sum Squares type: number validation_failures: default: null title: Validation Failures items: $ref: '#/components/schemas/ExperimentStatsValidationFailure' type: array nullable: true required: - key - number_of_samples - sum - sum_squares title: ExperimentStatsBaseValidated type: object _InsightQuerySchema: description: 'The query definition for this insight. The `kind` field determines the query type: - `InsightVizNode` — product analytics (trends, funnels, retention, paths, stickiness, lifecycle) - `DataVisualizationNode` — SQL insights using HogQL - `DataTableNode` — raw data tables - `HogQuery` — Hog language queries' discriminator: mapping: DataTableNode: '#/components/schemas/DataTableNode' DataVisualizationNode: '#/components/schemas/DataVisualizationNode' HogQuery: '#/components/schemas/HogQuery' InsightVizNode: '#/components/schemas/InsightVizNode' propertyName: kind oneOf: - $ref: '#/components/schemas/InsightVizNode' - $ref: '#/components/schemas/DataTableNode' - $ref: '#/components/schemas/DataVisualizationNode' - $ref: '#/components/schemas/HogQuery' title: _InsightQuerySchema RetentionEntityKind: enum: - ActionsNode - EventsNode title: RetentionEntityKind type: string EventMetadataPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: event_metadata title: Type type: string enum: - event_metadata value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: EventMetadataPropertyFilter type: object DetailedResultsAggregationType: enum: - total - average - median title: DetailedResultsAggregationType type: string FunnelCorrelationQuery: additionalProperties: false properties: funnelCorrelationEventExcludePropertyNames: default: null title: Funnelcorrelationeventexcludepropertynames items: type: string type: array nullable: true funnelCorrelationEventNames: default: null title: Funnelcorrelationeventnames items: type: string type: array nullable: true funnelCorrelationExcludeEventNames: default: null title: Funnelcorrelationexcludeeventnames items: type: string type: array nullable: true funnelCorrelationExcludeNames: default: null title: Funnelcorrelationexcludenames items: type: string type: array nullable: true funnelCorrelationNames: default: null title: Funnelcorrelationnames items: type: string type: array nullable: true funnelCorrelationType: $ref: '#/components/schemas/FunnelCorrelationResultsType' kind: default: FunnelCorrelationQuery title: Kind type: string enum: - FunnelCorrelationQuery response: default: null allOf: - $ref: '#/components/schemas/FunnelCorrelationResponse' nullable: true source: $ref: '#/components/schemas/FunnelsActorsQuery' version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - funnelCorrelationType - source title: FunnelCorrelationQuery type: object ChartSettingsDisplay: additionalProperties: false properties: color: default: null title: Color type: string nullable: true displayType: default: null allOf: - $ref: '#/components/schemas/DisplayType' nullable: true label: default: null title: Label type: string nullable: true trendLine: default: null title: Trendline type: boolean nullable: true yAxisPosition: default: null allOf: - $ref: '#/components/schemas/YAxisPosition' nullable: true title: ChartSettingsDisplay type: object LLMTracePerson: additionalProperties: false properties: created_at: title: Created At type: string distinct_id: title: Distinct Id type: string properties: type: object additionalProperties: true title: Properties uuid: title: Uuid type: string required: - created_at - distinct_id - properties - uuid title: LLMTracePerson type: object StickinessQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: additionalProperties: true type: object title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: StickinessQueryResponse type: object CustomChannelField: enum: - utm_source - utm_medium - utm_campaign - referring_domain - url - pathname - hostname title: CustomChannelField type: string EndpointsUsageTableQuery: additionalProperties: false properties: breakdownBy: $ref: '#/components/schemas/EndpointsUsageBreakdown' dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true endpointNames: default: null description: Filter to specific endpoints by name title: Endpointnames items: type: string type: array nullable: true kind: default: EndpointsUsageTableQuery title: Kind type: string enum: - EndpointsUsageTableQuery limit: default: null title: Limit type: integer nullable: true materializationType: default: null description: Filter by materialization type allOf: - $ref: '#/components/schemas/MaterializationType' nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/EndpointsUsageOrderByField' - $ref: '#/components/schemas/EndpointsUsageOrderByDirection' type: array nullable: true response: default: null allOf: - $ref: '#/components/schemas/EndpointsUsageTableQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - breakdownBy title: EndpointsUsageTableQuery type: object ActionEnum: enum: - add - remove - set type: string description: '* `add` - add * `remove` - remove * `set` - set' FunnelCorrelationResult: additionalProperties: false properties: events: items: $ref: '#/components/schemas/EventOddsRatioSerialized' title: Events type: array skewed: title: Skewed type: boolean required: - events - skewed title: FunnelCorrelationResult type: object QueryIndexUsage: enum: - undecisive - 'no' - partial - 'yes' title: QueryIndexUsage type: string MarketingAnalyticsAggregatedQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true draftConversionGoal: default: null description: Draft conversion goal that can be set in the UI without saving title: Draftconversiongoal anyOf: - $ref: '#/components/schemas/ConversionGoalFilter1' - $ref: '#/components/schemas/ConversionGoalFilter2' - $ref: '#/components/schemas/ConversionGoalFilter3' nullable: true drillDownLevel: default: null description: 'Drill-down hierarchy level: channel, source, or campaign (default)' allOf: - $ref: '#/components/schemas/MarketingAnalyticsDrillDownLevel' nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true integrationFilter: default: null description: Filter by integration IDs allOf: - $ref: '#/components/schemas/IntegrationFilter' nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: MarketingAnalyticsAggregatedQuery title: Kind type: string enum: - MarketingAnalyticsAggregatedQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/MarketingAnalyticsAggregatedQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true select: default: null description: Return a limited set of data. Will use default columns if empty. title: Select items: type: string type: array nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: MarketingAnalyticsAggregatedQuery type: object PropertyGroupsMode: enum: - enabled - disabled - optimized title: PropertyGroupsMode type: string BreakdownAttributionType: enum: - first_touch - last_touch - all_events - step title: BreakdownAttributionType type: string ExperimentQuery: additionalProperties: false properties: experiment_id: default: null title: Experiment Id type: integer nullable: true kind: default: ExperimentQuery title: Kind type: string enum: - ExperimentQuery metric: anyOf: - $ref: '#/components/schemas/ExperimentMeanMetric' - $ref: '#/components/schemas/ExperimentFunnelMetric' - $ref: '#/components/schemas/ExperimentRatioMetric' - $ref: '#/components/schemas/ExperimentRetentionMetric' title: Metric modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true name: default: null title: Name type: string nullable: true precomputation_mode: default: null allOf: - $ref: '#/components/schemas/PrecomputationMode' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ExperimentQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - metric title: ExperimentQuery type: object EndpointsUsageBreakdown: enum: - Endpoint - MaterializationType - ApiKey - Status title: EndpointsUsageBreakdown type: string EndpointsUsageTableQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: EndpointsUsageTableQueryResponse type: object WebVitalsPathBreakdownResultItem: additionalProperties: false properties: path: title: Path type: string value: title: Value type: number required: - path - value title: WebVitalsPathBreakdownResultItem type: object AlertConditionType: enum: - absolute_value - relative_increase - relative_decrease title: AlertConditionType type: string BlankEnum: enum: - '' MeanRetentionCalculation: enum: - simple - weighted - none title: MeanRetentionCalculation type: string ErrorTrackingIssueCorrelationQuery: additionalProperties: false properties: events: items: type: string title: Events type: array kind: default: ErrorTrackingIssueCorrelationQuery title: Kind type: string enum: - ErrorTrackingIssueCorrelationQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ErrorTrackingIssueCorrelationQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - events title: ErrorTrackingIssueCorrelationQuery type: object WebGoalsQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebGoalsQuery title: Kind type: string enum: - WebGoalsQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebGoalsQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: WebGoalsQuery type: object ElementPropertyFilter: additionalProperties: false properties: key: $ref: '#/components/schemas/Key10' label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: element title: Type type: string enum: - element value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: ElementPropertyFilter type: object PersonsNode: additionalProperties: false properties: cohort: default: null title: Cohort type: integer nullable: true distinctId: default: null title: Distinctid type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true kind: default: PersonsNode title: Kind type: string enum: - PersonsNode limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true search: default: null title: Search type: string nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: PersonsNode type: object WebExternalClicksTableQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebExternalClicksTableQuery title: Kind type: string enum: - WebExternalClicksTableQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebExternalClicksTableQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true stripQueryParams: default: null title: Stripqueryparams type: boolean nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: WebExternalClicksTableQuery type: object HeatmapSortOrder: enum: - asc - desc title: HeatmapSortOrder type: string StickinessComputationMode: enum: - non_cumulative - cumulative title: StickinessComputationMode type: string EventOddsRatioSerialized: additionalProperties: false properties: correlation_type: $ref: '#/components/schemas/CorrelationType' event: $ref: '#/components/schemas/EventDefinition' failure_count: title: Failure Count type: integer odds_ratio: title: Odds Ratio type: number success_count: title: Success Count type: integer required: - correlation_type - event - failure_count - odds_ratio - success_count title: EventOddsRatioSerialized type: object PaginatedThresholdWithAlertList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/ThresholdWithAlert' VolumeBucket: additionalProperties: false properties: label: title: Label type: string value: title: Value type: number required: - label - value title: VolumeBucket type: object MultipleVariantHandling: enum: - exclude - first_seen title: MultipleVariantHandling type: string HogQuery: additionalProperties: false properties: code: default: null title: Code type: string nullable: true kind: default: HogQuery title: Kind type: string enum: - HogQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true response: default: null allOf: - $ref: '#/components/schemas/HogQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: HogQuery type: object WebStatsTableQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true usedPreAggregatedTables: default: null title: Usedpreaggregatedtables type: boolean nullable: true required: - results title: WebStatsTableQueryResponse type: object ExperimentVariantFunnelsBaseStats: additionalProperties: false properties: failure_count: title: Failure Count type: number key: title: Key type: string success_count: title: Success Count type: number required: - failure_count - key - success_count title: ExperimentVariantFunnelsBaseStats type: object SessionData: additionalProperties: false properties: event_uuid: title: Event Uuid type: string person_id: title: Person Id type: string session_id: title: Session Id type: string timestamp: title: Timestamp type: string required: - event_uuid - person_id - session_id - timestamp title: SessionData type: object ErrorTrackingIssueAssigneeType: enum: - user - role title: ErrorTrackingIssueAssigneeType type: string FunnelPathsFilter: additionalProperties: false properties: funnelPathType: default: null allOf: - $ref: '#/components/schemas/FunnelPathType' nullable: true funnelSource: $ref: '#/components/schemas/FunnelsQuery' funnelStep: default: null title: Funnelstep type: integer nullable: true required: - funnelSource title: FunnelPathsFilter type: object MaterializationMode: enum: - auto - legacy_null_as_string - legacy_null_as_null - disabled title: MaterializationMode type: string Response22: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/ErrorTrackingCorrelatedIssue' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response22 type: object CountPerActorMathType: enum: - avg_count_per_actor - min_count_per_actor - max_count_per_actor - median_count_per_actor - p75_count_per_actor - p90_count_per_actor - p95_count_per_actor - p99_count_per_actor title: CountPerActorMathType type: string ConversionGoalFilter2: additionalProperties: false properties: conversion_goal_id: title: Conversion Goal Id type: string conversion_goal_name: title: Conversion Goal Name type: string custom_name: default: null title: Custom Name type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: integer kind: default: ActionsNode title: Kind type: string enum: - ActionsNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true schema_map: additionalProperties: anyOf: - type: string - {} title: Schema Map type: object version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - conversion_goal_id - conversion_goal_name - id - schema_map title: ConversionGoalFilter2 type: object LogPropertyFilterType: enum: - log - log_attribute - log_resource_attribute title: LogPropertyFilterType type: string CustomChannelCondition: additionalProperties: false properties: id: title: Id type: string key: $ref: '#/components/schemas/CustomChannelField' op: $ref: '#/components/schemas/CustomChannelOperator' value: default: null title: Value anyOf: - type: string - items: type: string type: array nullable: true required: - id - key - op title: CustomChannelCondition type: object RevenueAnalyticsBreakdown: additionalProperties: false properties: property: title: Property type: string type: default: revenue_analytics title: Type type: string enum: - revenue_analytics required: - property title: RevenueAnalyticsBreakdown type: object DataTableNodeViewPropsContext: additionalProperties: false properties: eventDefinitionId: default: null title: Eventdefinitionid type: string nullable: true type: $ref: '#/components/schemas/DataTableNodeViewPropsContextType' required: - type title: DataTableNodeViewPropsContext type: object ExperimentStatsValidationFailure: enum: - not-enough-exposures - baseline-mean-is-zero - not-enough-metric-data title: ExperimentStatsValidationFailure type: string MarketingAnalyticsTableQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: $ref: '#/components/schemas/MarketingAnalyticsItem' type: array title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: MarketingAnalyticsTableQueryResponse type: object ExperimentTrendsQuery: additionalProperties: false properties: count_query: $ref: '#/components/schemas/TrendsQuery' experiment_id: default: null title: Experiment Id type: integer nullable: true exposure_query: default: null allOf: - $ref: '#/components/schemas/TrendsQuery' nullable: true fingerprint: default: null title: Fingerprint type: string nullable: true kind: default: ExperimentTrendsQuery title: Kind type: string enum: - ExperimentTrendsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true name: default: null title: Name type: string nullable: true response: default: null allOf: - $ref: '#/components/schemas/ExperimentTrendsQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - count_query title: ExperimentTrendsQuery type: object LogEntryPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: log_entry title: Type type: string enum: - log_entry value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: LogEntryPropertyFilter type: object Response: additionalProperties: false properties: columns: items: {} title: Columns type: array error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: description: Generated HogQL query. title: Hogql type: string limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true nextCursor: default: null description: Cursor for fetching the next page of results title: Nextcursor type: string nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: {} type: array title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: items: type: string title: Types type: array required: - columns - hogql - results - types title: Response type: object MarketingAnalyticsTableQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null description: Compare to date range allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true draftConversionGoal: default: null description: Draft conversion goal that can be set in the UI without saving title: Draftconversiongoal anyOf: - $ref: '#/components/schemas/ConversionGoalFilter1' - $ref: '#/components/schemas/ConversionGoalFilter2' - $ref: '#/components/schemas/ConversionGoalFilter3' nullable: true drillDownLevel: default: null description: 'Drill-down hierarchy level: channel, source, or campaign (default)' allOf: - $ref: '#/components/schemas/MarketingAnalyticsDrillDownLevel' nullable: true filterTestAccounts: default: null description: Filter test accounts title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true integrationFilter: default: null description: Filter by integration type allOf: - $ref: '#/components/schemas/IntegrationFilter' nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: MarketingAnalyticsTableQuery title: Kind type: string enum: - MarketingAnalyticsTableQuery limit: default: null description: Number of rows to return title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null description: Number of rows to skip before returning rows title: Offset type: integer nullable: true orderBy: default: null description: Columns to order by - similar to EventsQuery format title: Orderby items: items: anyOf: - type: string - $ref: '#/components/schemas/MarketingAnalyticsOrderByEnum' type: array type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/MarketingAnalyticsTableQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true select: default: null description: Return a limited set of data. Will use default columns if empty. title: Select items: type: string type: array nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: MarketingAnalyticsTableQuery type: object EndpointsUsageOrderByField: enum: - requests - bytes_read - cpu_seconds - avg_query_duration_ms - error_rate title: EndpointsUsageOrderByField type: string DisplayType: enum: - auto - line - bar - area title: DisplayType type: string EventPropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: default: exact allOf: - $ref: '#/components/schemas/PropertyOperator' nullable: true type: default: event description: Event properties title: Type type: string enum: - event value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key title: EventPropertyFilter type: object RetentionQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/RetentionResult' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RetentionQueryResponse type: object IntervalType: enum: - second - minute - hour - day - week - month title: IntervalType type: string MarketingAnalyticsOrderByEnum: enum: - ASC - DESC title: MarketingAnalyticsOrderByEnum type: string Filters: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true properties: default: null title: Properties items: $ref: '#/components/schemas/SessionPropertyFilter' type: array nullable: true title: Filters type: object HBOSDetectorConfig: additionalProperties: false properties: n_bins: default: null description: 'Number of histogram bins (default: 10)' title: N Bins type: integer nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: hbos title: Type type: string enum: - hbos window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: HBOSDetectorConfig type: object Response15: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response15 type: object DataVisualizationNode: additionalProperties: false properties: chartSettings: default: null allOf: - $ref: '#/components/schemas/ChartSettings' nullable: true display: default: null allOf: - $ref: '#/components/schemas/ChartDisplayType' nullable: true kind: default: DataVisualizationNode title: Kind type: string enum: - DataVisualizationNode source: $ref: '#/components/schemas/HogQLQuery' tableSettings: default: null allOf: - $ref: '#/components/schemas/TableSettings' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: DataVisualizationNode type: object 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 - in - not_in - is_cleaned_path_exact - flag_evaluates_to - semver_eq - semver_neq - semver_gt - semver_gte - semver_lt - semver_lte - semver_tilde - semver_caret - semver_wildcard - icontains_multi - not_icontains_multi title: PropertyOperator type: string EventDefinition: additionalProperties: false properties: elements: items: {} title: Elements type: array event: title: Event type: string properties: type: object additionalProperties: true title: Properties required: - elements - event - properties title: EventDefinition type: object ConversionGoalFilter3: additionalProperties: false properties: conversion_goal_id: title: Conversion Goal Id type: string conversion_goal_name: title: Conversion Goal Name type: string custom_name: default: null title: Custom Name type: string nullable: true distinct_id_field: title: Distinct Id Field type: string dw_source_type: default: null title: Dw Source Type type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: string id_field: title: Id Field type: string kind: default: DataWarehouseNode title: Kind type: string enum: - DataWarehouseNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true schema_map: additionalProperties: anyOf: - type: string - {} title: Schema Map type: object table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - conversion_goal_id - conversion_goal_name - distinct_id_field - id - id_field - schema_map - table_name - timestamp_field title: ConversionGoalFilter3 type: object WebOverviewQueryResponse: additionalProperties: false properties: dateFrom: default: null title: Datefrom type: string nullable: true dateTo: default: null title: Dateto type: string nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/WebOverviewItem' title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true usedPreAggregatedTables: default: null title: Usedpreaggregatedtables type: boolean nullable: true required: - results title: WebOverviewQueryResponse type: object SessionAttributionExplorerQuery: additionalProperties: false properties: filters: default: null allOf: - $ref: '#/components/schemas/Filters' nullable: true groupBy: items: $ref: '#/components/schemas/SessionAttributionGroupBy' title: Groupby type: array kind: default: SessionAttributionExplorerQuery title: Kind type: string enum: - SessionAttributionExplorerQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true response: default: null allOf: - $ref: '#/components/schemas/SessionAttributionExplorerQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - groupBy title: SessionAttributionExplorerQuery type: object LastEvent: additionalProperties: false properties: distinct_id: title: Distinct Id type: string properties: type: string title: Properties timestamp: title: Timestamp type: string uuid: title: Uuid type: string required: - distinct_id - properties - timestamp - uuid title: LastEvent type: object Response19: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: additionalProperties: $ref: '#/components/schemas/MarketingAnalyticsItem' title: Results type: object samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response19 type: object CalculationIntervalEnum: enum: - hourly - daily - weekly - monthly type: string description: '* `hourly` - hourly * `daily` - daily * `weekly` - weekly * `monthly` - monthly' RevenueAnalyticsMRRQuery: additionalProperties: false properties: breakdown: items: $ref: '#/components/schemas/RevenueAnalyticsBreakdown' title: Breakdown type: array dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true interval: $ref: '#/components/schemas/SimpleIntervalType' kind: default: RevenueAnalyticsMRRQuery title: Kind type: string enum: - RevenueAnalyticsMRRQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/RevenueAnalyticsMRRQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - breakdown - interval - properties title: RevenueAnalyticsMRRQuery type: object HogQLQuery: additionalProperties: false properties: connectionId: default: null description: Optional direct external data source id for running against a specific source title: Connectionid type: string nullable: true explain: default: null title: Explain type: boolean nullable: true filters: default: null allOf: - $ref: '#/components/schemas/HogQLFilters' nullable: true kind: default: HogQLQuery title: Kind type: string enum: - HogQLQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true name: default: null description: Client provided name of the query title: Name type: string nullable: true query: title: Query type: string response: default: null allOf: - $ref: '#/components/schemas/HogQLQueryResponse' nullable: true sendRawQuery: default: null description: Run the selected connection query directly without translating it through HogQL first title: Sendrawquery type: boolean nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true values: default: null description: Constant values that can be referenced with the {placeholder} syntax in the query title: Values additionalProperties: true type: object nullable: true variables: default: null description: Variables to be substituted into the query title: Variables additionalProperties: $ref: '#/components/schemas/HogQLVariable' type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - query title: HogQLQuery type: object FunnelsQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: FunnelsQueryResponse type: object AggregationType: enum: - count - sum - avg title: AggregationType type: string RevenueAnalyticsMRRQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/RevenueAnalyticsMRRQueryResultItem' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RevenueAnalyticsMRRQueryResponse type: object Style: enum: - none - number - short - percent title: Style type: string RevenueAnalyticsOverviewItemKey: enum: - revenue - paying_customer_count - avg_revenue_per_customer title: RevenueAnalyticsOverviewItemKey type: string WorkflowVariablePropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: workflow_variable title: Type type: string enum: - workflow_variable value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: WorkflowVariablePropertyFilter type: object UserBasic: type: object properties: id: type: integer readOnly: true uuid: type: string format: uuid readOnly: true distinct_id: type: string nullable: true maxLength: 200 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 email: type: string format: email title: Email address maxLength: 254 is_email_verified: type: boolean nullable: true hedgehog_config: type: object additionalProperties: true nullable: true readOnly: true role_at_organization: nullable: true oneOf: - $ref: '#/components/schemas/RoleAtOrganizationEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' required: - email - hedgehog_config - id - uuid ErrorTrackingIssueCohort: additionalProperties: false properties: id: title: Id type: number name: title: Name type: string required: - id - name title: ErrorTrackingIssueCohort type: object FunnelPathType: enum: - funnel_path_before_step - funnel_path_between_steps - funnel_path_after_step title: FunnelPathType type: string BulkUpdateTagsRequest: type: object properties: ids: type: array items: type: integer description: List of object IDs to update tags on. maxItems: 500 action: allOf: - $ref: '#/components/schemas/ActionEnum' description: '''add'' merges with existing tags, ''remove'' deletes specific tags, ''set'' replaces all tags. * `add` - add * `remove` - remove * `set` - set' tags: type: array items: type: string description: Tag names to add, remove, or set. required: - action - ids - tags InsightThreshold: additionalProperties: false properties: bounds: default: null allOf: - $ref: '#/components/schemas/InsightsThresholdBounds' nullable: true type: description: Whether bounds are compared as absolute values or as percentage change from the previous interval. allOf: - $ref: '#/components/schemas/InsightThresholdType' required: - type title: InsightThreshold type: object HogQLQueryResponse: additionalProperties: false properties: clickhouse: default: null description: Executed ClickHouse query title: Clickhouse type: string nullable: true columns: default: null description: Returned columns title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true explain: default: null description: Query explanation output title: Explain items: type: string type: array nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true metadata: default: null description: Query metadata output allOf: - $ref: '#/components/schemas/HogQLMetadataResponse' nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query: default: null description: Input query string title: Query type: string nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null description: Types of returned columns title: Types items: {} type: array nullable: true required: - results title: HogQLQueryResponse type: object FunnelMathType: enum: - total - first_time_for_user - first_time_for_user_with_filters title: FunnelMathType type: string InvestigationVerdictEnum: enum: - true_positive - false_positive - inconclusive type: string description: '* `true_positive` - true_positive * `false_positive` - false_positive * `inconclusive` - inconclusive' PathsFilter: additionalProperties: false properties: edgeLimit: default: 50 title: Edgelimit type: integer nullable: true endPoint: default: null title: Endpoint type: string nullable: true excludeEvents: default: null title: Excludeevents items: type: string type: array nullable: true includeEventTypes: default: null title: Includeeventtypes items: $ref: '#/components/schemas/PathType' type: array nullable: true localPathCleaningFilters: default: null title: Localpathcleaningfilters items: $ref: '#/components/schemas/PathCleaningFilter' type: array nullable: true maxEdgeWeight: default: null title: Maxedgeweight type: integer nullable: true minEdgeWeight: default: null title: Minedgeweight type: integer nullable: true pathDropoffKey: default: null description: Relevant only within actors query title: Pathdropoffkey type: string nullable: true pathEndKey: default: null description: Relevant only within actors query title: Pathendkey type: string nullable: true pathGroupings: default: null title: Pathgroupings items: type: string type: array nullable: true pathReplacements: default: null title: Pathreplacements type: boolean nullable: true pathStartKey: default: null description: Relevant only within actors query title: Pathstartkey type: string nullable: true pathsHogQLExpression: default: null title: Pathshogqlexpression type: string nullable: true showFullUrls: default: null title: Showfullurls type: boolean nullable: true startPoint: default: null title: Startpoint type: string nullable: true stepLimit: default: 5 title: Steplimit type: integer nullable: true title: PathsFilter type: object PersonsArgMaxVersion: enum: - auto - v1 - v2 title: PersonsArgMaxVersion type: string Response8: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/WebVitalsPathBreakdownResult' maxItems: 1 minItems: 1 title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response8 type: object CorrelationType: enum: - success - failure title: CorrelationType type: string RevenueAnalyticsOverviewQuery: additionalProperties: false properties: dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true kind: default: RevenueAnalyticsOverviewQuery title: Kind type: string enum: - RevenueAnalyticsOverviewQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/RevenueAnalyticsOverviewQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: RevenueAnalyticsOverviewQuery type: object ExperimentFunnelMetric: additionalProperties: false properties: breakdownFilter: default: null allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true conversion_window: default: null title: Conversion Window type: integer nullable: true conversion_window_unit: default: null allOf: - $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' nullable: true fingerprint: default: null title: Fingerprint type: string nullable: true funnel_order_type: default: null allOf: - $ref: '#/components/schemas/StepOrderValue' nullable: true goal: default: null allOf: - $ref: '#/components/schemas/ExperimentMetricGoal' nullable: true isSharedMetric: default: null title: Issharedmetric type: boolean nullable: true kind: default: ExperimentMetric title: Kind type: string enum: - ExperimentMetric metric_type: default: funnel title: Metric Type type: string enum: - funnel name: default: null title: Name type: string nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true series: items: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Series type: array sharedMetricId: default: null title: Sharedmetricid type: number nullable: true uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - series title: ExperimentFunnelMetric type: object WebStatsBreakdown: enum: - Page - InitialPage - ExitPage - ExitClick - PreviousPage - ScreenName - InitialChannelType - InitialReferringDomain - InitialReferringURL - InitialUTMSource - InitialUTMCampaign - InitialUTMMedium - InitialUTMTerm - InitialUTMContent - InitialUTMSourceMediumCampaign - Browser - OS - Viewport - DeviceType - Country - Region - City - Timezone - Language - FrustrationMetrics title: WebStatsBreakdown type: string Breakdown: additionalProperties: false properties: group_type_index: default: null title: Group Type Index type: integer nullable: true histogram_bin_count: default: null title: Histogram Bin Count type: integer nullable: true normalize_url: default: null title: Normalize Url type: boolean nullable: true property: anyOf: - type: string - type: integer title: Property type: default: null allOf: - $ref: '#/components/schemas/MultipleBreakdownType' nullable: true required: - property title: Breakdown type: object DateRange: additionalProperties: false properties: date_from: default: null description: 'Start of the date range. Accepts ISO 8601 timestamps (e.g., 2024-01-15T00:00:00Z) or relative formats: -7d (7 days ago), -2w (2 weeks ago), -1m (1 month ago), -1h (1 hour ago), -1mStart (start of last month), -1yStart (start of last year).' title: Date From type: string nullable: true date_to: default: null description: End of the date range. Same format as date_from. Omit or null for "now". title: Date To type: string nullable: true explicitDate: default: false description: Whether the date_from and date_to should be used verbatim. Disables rounding to the start and end of period. title: Explicitdate type: boolean nullable: true title: DateRange type: object IntegrationFilter: additionalProperties: false properties: integrationSourceIds: default: null description: Selected integration source IDs to filter by (e.g., table IDs or source map IDs) title: Integrationsourceids items: type: string type: array nullable: true title: IntegrationFilter type: object ExperimentFunnelsQuery: additionalProperties: false properties: experiment_id: default: null title: Experiment Id type: integer nullable: true fingerprint: default: null title: Fingerprint type: string nullable: true funnels_query: $ref: '#/components/schemas/FunnelsQuery' kind: default: ExperimentFunnelsQuery title: Kind type: string enum: - ExperimentFunnelsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true name: default: null title: Name type: string nullable: true response: default: null allOf: - $ref: '#/components/schemas/ExperimentFunnelsQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - funnels_query title: ExperimentFunnelsQuery type: object BulkUpdateTagsResponse: type: object properties: updated: type: array items: $ref: '#/components/schemas/BulkUpdateTagsItem' skipped: type: array items: $ref: '#/components/schemas/BulkUpdateTagsError' required: - skipped - updated IQRDetectorConfig: additionalProperties: false properties: multiplier: default: null description: 'IQR multiplier for fence calculation (default: 1.5, use 3.0 for far outliers)' title: Multiplier type: number nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true type: default: iqr title: Type type: string enum: - iqr window: default: null description: 'Rolling window size for calculating quartiles (default: 30)' title: Window type: integer nullable: true title: IQRDetectorConfig type: object EnsembleOperator: enum: - and - or title: EnsembleOperator type: string FunnelsActorsQuery: additionalProperties: false properties: funnelStep: default: null 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. title: Funnelstep type: integer nullable: true funnelStepBreakdown: default: null 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. title: Funnelstepbreakdown anyOf: - type: integer - type: string - type: number - items: anyOf: - type: integer - type: string - type: number type: array nullable: true funnelTrendsDropOff: default: null title: Funneltrendsdropoff type: boolean nullable: true funnelTrendsEntrancePeriodStart: default: null description: Used together with `funnelTrendsDropOff` for funnels time conversion date for the persons modal. title: Funneltrendsentranceperiodstart type: string nullable: true includeRecordings: default: null title: Includerecordings type: boolean nullable: true kind: default: FunnelsActorsQuery title: Kind type: string enum: - FunnelsActorsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true source: $ref: '#/components/schemas/FunnelsQuery' tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: FunnelsActorsQuery type: object LOFDetectorConfig: additionalProperties: false properties: n_neighbors: default: null description: 'Number of neighbors for LOF (default: 20)' title: N Neighbors type: integer nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: lof title: Type type: string enum: - lof window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: LOFDetectorConfig type: object AlertCheck: type: object properties: id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true calculated_value: type: number format: double readOnly: true nullable: true state: allOf: - $ref: '#/components/schemas/AlertCheckStateEnum' readOnly: true targets_notified: type: boolean readOnly: true anomaly_scores: readOnly: true nullable: true triggered_points: readOnly: true nullable: true triggered_dates: readOnly: true nullable: true interval: type: string readOnly: true nullable: true triggered_metadata: readOnly: true nullable: true investigation_status: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/InvestigationStatusEnum' - $ref: '#/components/schemas/NullEnum' investigation_verdict: readOnly: true nullable: true oneOf: - $ref: '#/components/schemas/InvestigationVerdictEnum' - $ref: '#/components/schemas/NullEnum' investigation_summary: type: string readOnly: true nullable: true investigation_notebook_short_id: type: string nullable: true readOnly: true description: Short ID of the Notebook produced by the investigation agent, when the agent ran for this check. notification_sent_at: type: string format: date-time readOnly: true nullable: true notification_suppressed_by_agent: type: boolean readOnly: true required: - anomaly_scores - calculated_value - created_at - id - interval - investigation_notebook_short_id - investigation_status - investigation_summary - investigation_verdict - notification_sent_at - notification_suppressed_by_agent - state - targets_notified - triggered_dates - triggered_metadata - triggered_points Response4: additionalProperties: false properties: dateFrom: default: null title: Datefrom type: string nullable: true dateTo: default: null title: Dateto type: string nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/WebOverviewItem' title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true usedPreAggregatedTables: default: null title: Usedpreaggregatedtables type: boolean nullable: true required: - results title: Response4 type: object NullEnum: enum: - null MarketingAnalyticsItem: additionalProperties: false properties: changeFromPreviousPct: default: null title: Changefrompreviouspct type: number nullable: true hasComparison: default: null title: Hascomparison type: boolean nullable: true isIncreaseBad: default: null title: Isincreasebad type: boolean nullable: true key: title: Key type: string kind: $ref: '#/components/schemas/WebAnalyticsItemKind' previous: default: null title: Previous anyOf: - type: number - type: string nullable: true value: default: null title: Value anyOf: - type: number - type: string nullable: true required: - key - kind title: MarketingAnalyticsItem type: object PrecomputationMode: enum: - precomputed - direct title: PrecomputationMode type: string AggregationAxisFormat: enum: - numeric - duration - duration_ms - percentage - percentage_scaled - currency - short title: AggregationAxisFormat type: string Settings: additionalProperties: false properties: display: default: null allOf: - $ref: '#/components/schemas/ChartSettingsDisplay' nullable: true formatting: default: null allOf: - $ref: '#/components/schemas/ChartSettingsFormatting' nullable: true title: Settings type: object SharingConfiguration: type: object properties: created_at: type: string format: date-time readOnly: true enabled: type: boolean access_token: type: string readOnly: true nullable: true settings: nullable: true password_required: type: boolean share_passwords: type: array items: $ref: '#/components/schemas/SharePassword' readOnly: true required: - access_token - created_at - share_passwords BreakdownType: enum: - cohort - person - event - event_metadata - group - session - hogql - data_warehouse - data_warehouse_person_property - revenue_analytics title: BreakdownType type: string TrendsFormulaNode: additionalProperties: false properties: custom_name: default: null description: Optional user-defined name for the formula title: Custom Name type: string nullable: true formula: title: Formula type: string required: - formula title: TrendsFormulaNode type: object HogQLMetadataResponse: additionalProperties: false properties: ch_table_names: default: null title: Ch Table Names items: type: string type: array nullable: true errors: items: $ref: '#/components/schemas/HogQLNotice' title: Errors type: array isUsingIndices: default: null allOf: - $ref: '#/components/schemas/QueryIndexUsage' nullable: true isValid: default: null title: Isvalid type: boolean nullable: true notices: items: $ref: '#/components/schemas/HogQLNotice' title: Notices type: array query: default: null title: Query type: string nullable: true table_names: default: null title: Table Names items: type: string type: array nullable: true warnings: items: $ref: '#/components/schemas/HogQLNotice' title: Warnings type: array required: - errors - notices - warnings title: HogQLMetadataResponse type: object OrderDirection2: enum: - ASC - DESC title: OrderDirection2 type: string TraceQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/LLMTrace' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: TraceQueryResponse type: object ExperimentMeanMetric: additionalProperties: false properties: breakdownFilter: default: null allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true conversion_window: default: null title: Conversion Window type: integer nullable: true conversion_window_unit: default: null allOf: - $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' nullable: true fingerprint: default: null title: Fingerprint type: string nullable: true goal: default: null allOf: - $ref: '#/components/schemas/ExperimentMetricGoal' nullable: true ignore_zeros: default: null title: Ignore Zeros type: boolean nullable: true isSharedMetric: default: null title: Issharedmetric type: boolean nullable: true kind: default: ExperimentMetric title: Kind type: string enum: - ExperimentMetric lower_bound_percentile: default: null title: Lower Bound Percentile type: number nullable: true metric_type: default: mean title: Metric Type type: string enum: - mean name: default: null title: Name type: string nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true sharedMetricId: default: null title: Sharedmetricid type: number nullable: true source: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Source upper_bound_percentile: default: null title: Upper Bound Percentile type: number nullable: true uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: ExperimentMeanMetric type: object ExperimentMetricMathType: enum: - total - sum - unique_session - min - max - avg - dau - unique_group - hogql title: ExperimentMetricMathType type: string HogQLNotice: additionalProperties: false properties: end: default: null title: End type: integer nullable: true fix: default: null title: Fix type: string nullable: true message: title: Message type: string start: default: null title: Start type: integer nullable: true required: - message title: HogQLNotice type: object OCSVMDetectorConfig: additionalProperties: false properties: kernel: default: null description: 'SVM kernel type (default: "rbf")' title: Kernel type: string nullable: true nu: default: null description: 'Upper bound on training errors fraction (default: 0.1)' title: Nu type: number nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: ocsvm title: Type type: string enum: - ocsvm window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: OCSVMDetectorConfig type: object Response23: additionalProperties: false properties: credible_intervals: additionalProperties: items: type: number type: array title: Credible Intervals type: object expected_loss: title: Expected Loss type: number funnels_query: default: null allOf: - $ref: '#/components/schemas/FunnelsQuery' nullable: true insight: items: items: additionalProperties: true type: object type: array title: Insight type: array kind: default: ExperimentFunnelsQuery title: Kind type: string enum: - ExperimentFunnelsQuery probability: additionalProperties: type: number title: Probability type: object significance_code: $ref: '#/components/schemas/ExperimentSignificanceCode' significant: title: Significant type: boolean stats_version: default: null title: Stats Version type: integer nullable: true variants: items: $ref: '#/components/schemas/ExperimentVariantFunnelsBaseStats' title: Variants type: array required: - credible_intervals - expected_loss - insight - probability - significance_code - significant - variants title: Response23 type: object DataTableNodeViewPropsContextType: enum: - event_definition - team_columns title: DataTableNodeViewPropsContextType type: string SamplingRate: additionalProperties: false properties: denominator: default: null title: Denominator type: number nullable: true numerator: title: Numerator type: number required: - numerator title: SamplingRate type: object DashboardTileBasic: type: object properties: id: type: integer readOnly: true dashboard_id: type: integer readOnly: true deleted: type: boolean nullable: true required: - dashboard_id - id MathGroupTypeIndex: enum: - 0.0 - 1.0 - 2.0 - 3.0 - 4.0 title: MathGroupTypeIndex type: number FunnelCorrelationActorsQuery: additionalProperties: false properties: funnelCorrelationPersonConverted: default: null title: Funnelcorrelationpersonconverted type: boolean nullable: true funnelCorrelationPersonEntity: default: null title: Funnelcorrelationpersonentity anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/DataWarehouseNode' nullable: true funnelCorrelationPropertyValues: default: null title: Funnelcorrelationpropertyvalues items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true includeRecordings: default: null title: Includerecordings type: boolean nullable: true kind: default: FunnelCorrelationActorsQuery title: Kind type: string enum: - FunnelCorrelationActorsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true response: default: null allOf: - $ref: '#/components/schemas/ActorsQueryResponse' nullable: true source: $ref: '#/components/schemas/FunnelCorrelationQuery' tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: FunnelCorrelationActorsQuery type: object GroupsQuery: additionalProperties: false properties: group_type_index: title: Group Type Index type: integer kind: default: GroupsQuery title: Kind type: string enum: - GroupsQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true orderBy: default: null title: Orderby items: type: string type: array nullable: true properties: default: null title: Properties items: anyOf: - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' type: array nullable: true response: default: null allOf: - $ref: '#/components/schemas/GroupsQueryResponse' nullable: true search: default: null title: Search type: string nullable: true select: default: null title: Select items: type: string type: array nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - group_type_index title: GroupsQuery type: object SharePassword: type: object properties: id: type: integer readOnly: true created_at: type: string format: date-time readOnly: true note: type: string nullable: true maxLength: 100 created_by_email: type: string readOnly: true is_active: type: boolean readOnly: true required: - created_at - created_by_email - id - is_active GroupPropertyFilter: additionalProperties: false properties: group_key_names: default: null title: Group Key Names additionalProperties: type: string type: object nullable: true group_type_index: default: null title: Group Type Index type: integer nullable: true key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: group title: Type type: string enum: - group value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: GroupPropertyFilter type: object StartHandling: enum: - first_seen - last_seen title: StartHandling type: string VizSpecificOptions: additionalProperties: false properties: ActionsPie: default: null allOf: - $ref: '#/components/schemas/ActionsPie' nullable: true RETENTION: default: null allOf: - $ref: '#/components/schemas/RETENTION' nullable: true title: VizSpecificOptions type: object HeatmapSettings: additionalProperties: false properties: gradient: default: null title: Gradient items: $ref: '#/components/schemas/HeatmapGradientStop' type: array nullable: true gradientPreset: default: null title: Gradientpreset type: string nullable: true gradientScaleMode: default: null allOf: - $ref: '#/components/schemas/GradientScaleMode' nullable: true nullLabel: default: null title: Nulllabel type: string nullable: true nullValue: default: null title: Nullvalue type: string nullable: true sortColumn: default: null title: Sortcolumn type: string nullable: true sortOrder: default: null allOf: - $ref: '#/components/schemas/HeatmapSortOrder' nullable: true valueColumn: default: null title: Valuecolumn type: string nullable: true xAxisColumn: default: null title: Xaxiscolumn type: string nullable: true xAxisLabel: default: null title: Xaxislabel type: string nullable: true yAxisColumn: default: null title: Yaxiscolumn type: string nullable: true yAxisLabel: default: null title: Yaxislabel type: string nullable: true title: HeatmapSettings type: object TableSettings: additionalProperties: false properties: columns: default: null title: Columns items: $ref: '#/components/schemas/ChartAxis' type: array nullable: true conditionalFormatting: default: null title: Conditionalformatting items: $ref: '#/components/schemas/ConditionalFormattingRule' type: array nullable: true pinnedColumns: default: null title: Pinnedcolumns items: type: string type: array nullable: true transpose: default: null title: Transpose type: boolean nullable: true title: TableSettings type: object FunnelsQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation title: Aggregation Group Type Index type: integer nullable: true breakdownFilter: default: null description: Breakdown of the events and actions allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true funnelsFilter: default: null description: Properties specific to the funnels insight allOf: - $ref: '#/components/schemas/FunnelsFilter' nullable: true interval: default: null description: Granularity of the response. Can be one of `hour`, `day`, `week` or `month` allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: FunnelsQuery title: Kind type: string enum: - FunnelsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/FunnelsQueryResponse' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true series: description: Events and actions to include items: anyOf: - $ref: '#/components/schemas/GroupNode' - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/FunnelsDataWarehouseNode' title: Series type: array tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - series title: FunnelsQuery type: object ChartSettings: additionalProperties: false properties: goalLines: default: null title: Goallines items: $ref: '#/components/schemas/GoalLine' type: array nullable: true heatmap: default: null allOf: - $ref: '#/components/schemas/HeatmapSettings' nullable: true leftYAxisSettings: default: null allOf: - $ref: '#/components/schemas/YAxisSettings' nullable: true rightYAxisSettings: default: null allOf: - $ref: '#/components/schemas/YAxisSettings' nullable: true seriesBreakdownColumn: default: null title: Seriesbreakdowncolumn type: string nullable: true showLegend: default: null title: Showlegend type: boolean nullable: true showNullsAsZero: default: null title: Shownullsaszero type: boolean nullable: true showPieTotal: default: null title: Showpietotal type: boolean nullable: true showTotalRow: default: null title: Showtotalrow type: boolean nullable: true showValuesOnSeries: default: null title: Showvaluesonseries type: boolean nullable: true showXAxisBorder: default: null title: Showxaxisborder type: boolean nullable: true showXAxisTicks: default: null title: Showxaxisticks type: boolean nullable: true showYAxisBorder: default: null title: Showyaxisborder type: boolean nullable: true stackBars100: default: null description: Whether we fill the bars to 100% in stacked mode title: Stackbars100 type: boolean nullable: true xAxis: default: null allOf: - $ref: '#/components/schemas/ChartAxis' nullable: true yAxis: default: null title: Yaxis items: $ref: '#/components/schemas/ChartAxis' type: array nullable: true yAxisAtZero: default: null description: 'Deprecated: use `[left|right]YAxisSettings`. Whether the Y axis should start at zero' title: Yaxisatzero type: boolean nullable: true title: ChartSettings type: object AggregationPropertyType: enum: - event - person title: AggregationPropertyType type: string WebAnalyticsItemKind: enum: - unit - duration_s - percentage - currency title: WebAnalyticsItemKind type: string Response14: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/RevenueAnalyticsOverviewItem' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response14 type: object RevenueAnalyticsMetricsQuery: additionalProperties: false properties: breakdown: items: $ref: '#/components/schemas/RevenueAnalyticsBreakdown' title: Breakdown type: array dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true interval: $ref: '#/components/schemas/SimpleIntervalType' kind: default: RevenueAnalyticsMetricsQuery title: Kind type: string enum: - RevenueAnalyticsMetricsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/RevenueAnalyticsMetricsQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - breakdown - interval - properties title: RevenueAnalyticsMetricsQuery type: object BulkUpdateTagsItem: type: object properties: id: type: integer tags: type: array items: type: string required: - id - tags ResultCustomizationByPosition: additionalProperties: false properties: assignmentBy: default: position title: Assignmentby type: string enum: - position color: default: null allOf: - $ref: '#/components/schemas/DataColorToken' nullable: true hidden: default: null title: Hidden type: boolean nullable: true title: ResultCustomizationByPosition type: object MarketingAnalyticsAggregatedQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: additionalProperties: $ref: '#/components/schemas/MarketingAnalyticsItem' title: Results type: object samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: MarketingAnalyticsAggregatedQueryResponse type: object WebVitalsQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebVitalsQuery title: Kind type: string enum: - WebVitalsQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebGoalsQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true source: discriminator: mapping: FunnelsQuery: '#/components/schemas/FunnelsQuery' LifecycleQuery: '#/components/schemas/LifecycleQuery' PathsQuery: '#/components/schemas/PathsQuery' RetentionQuery: '#/components/schemas/RetentionQuery' StickinessQuery: '#/components/schemas/StickinessQuery' TrendsQuery: '#/components/schemas/TrendsQuery' WebOverviewQuery: '#/components/schemas/WebOverviewQuery' WebStatsTableQuery: '#/components/schemas/WebStatsTableQuery' propertyName: kind 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' - $ref: '#/components/schemas/WebStatsTableQuery' - $ref: '#/components/schemas/WebOverviewQuery' title: Source tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties - source title: WebVitalsQuery type: object FunnelsDataWarehouseNode: additionalProperties: false properties: aggregation_target_field: title: Aggregation Target Field type: string custom_name: default: null title: Custom Name type: string nullable: true dw_source_type: default: null title: Dw Source Type type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true id: title: Id type: string id_field: title: Id Field type: string kind: default: FunnelsDataWarehouseNode title: Kind type: string enum: - FunnelsDataWarehouseNode math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - aggregation_target_field - id - id_field - table_name - timestamp_field title: FunnelsDataWarehouseNode type: object RevenueAnalyticsMetricsQueryResponse: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RevenueAnalyticsMetricsQueryResponse type: object WebAnalyticsOrderByDirection: enum: - ASC - DESC title: WebAnalyticsOrderByDirection type: string WebAnalyticsOrderByFields: enum: - Visitors - Views - AvgTimeOnPage - Clicks - BounceRate - AverageScrollPercentage - ScrollGt80Percentage - TotalConversions - UniqueConversions - ConversionRate - ConvertingUsers - RageClicks - DeadClicks - Errors title: WebAnalyticsOrderByFields type: string CustomEventConversionGoal: additionalProperties: false properties: customEventName: title: Customeventname type: string required: - customEventName title: CustomEventConversionGoal type: object FilterLogicalOperator: enum: - AND - OR title: FilterLogicalOperator type: string AlertCondition: additionalProperties: false properties: type: $ref: '#/components/schemas/AlertConditionType' required: - type title: AlertCondition type: object FunnelExclusionEventsNode: additionalProperties: false properties: custom_name: default: null title: Custom Name type: string nullable: true event: default: null description: The event or `null` for all events. title: Event type: string nullable: true fixedProperties: default: null description: Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person) title: Fixedproperties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true funnelFromStep: title: Funnelfromstep type: integer funnelToStep: title: Funneltostep type: integer kind: default: EventsNode title: Kind type: string enum: - EventsNode limit: default: null title: Limit type: integer nullable: true math: default: null title: Math anyOf: - $ref: '#/components/schemas/BaseMathType' - $ref: '#/components/schemas/FunnelMathType' - $ref: '#/components/schemas/PropertyMathType' - $ref: '#/components/schemas/CountPerActorMathType' - $ref: '#/components/schemas/ExperimentMetricMathType' - $ref: '#/components/schemas/CalendarHeatmapMathType' - type: string enum: - unique_group - type: string enum: - hogql nullable: true math_group_type_index: default: null allOf: - $ref: '#/components/schemas/MathGroupTypeIndex' nullable: true math_hogql: default: null title: Math Hogql type: string nullable: true math_multiplier: default: null title: Math Multiplier type: number nullable: true math_property: default: null title: Math Property type: string nullable: true math_property_revenue_currency: default: null allOf: - $ref: '#/components/schemas/RevenueCurrencyPropertyConfig' nullable: true math_property_type: default: null title: Math Property Type type: string nullable: true name: default: null title: Name type: string nullable: true optionalInFunnel: default: null title: Optionalinfunnel type: boolean nullable: true orderBy: default: null description: Columns to order by title: Orderby items: type: string type: array nullable: true properties: default: null description: Properties configurable in the interface title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - funnelFromStep - funnelToStep title: FunnelExclusionEventsNode type: object InvestigationInconclusiveActionEnum: enum: - notify - suppress type: string description: '* `notify` - Notify * `suppress` - Suppress' ErrorTrackingIssueStatus: enum: - archived - active - resolved - pending_release - suppressed title: ErrorTrackingIssueStatus type: string ExperimentRatioMetric: additionalProperties: false properties: breakdownFilter: default: null allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true conversion_window: default: null title: Conversion Window type: integer nullable: true conversion_window_unit: default: null allOf: - $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' nullable: true denominator: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Denominator fingerprint: default: null title: Fingerprint type: string nullable: true goal: default: null allOf: - $ref: '#/components/schemas/ExperimentMetricGoal' nullable: true isSharedMetric: default: null title: Issharedmetric type: boolean nullable: true kind: default: ExperimentMetric title: Kind type: string enum: - ExperimentMetric metric_type: default: ratio title: Metric Type type: string enum: - ratio name: default: null title: Name type: string nullable: true numerator: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Numerator response: default: null title: Response additionalProperties: true type: object nullable: true sharedMetricId: default: null title: Sharedmetricid type: number nullable: true uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - denominator - numerator title: ExperimentRatioMetric type: object YAxisSettings: additionalProperties: false properties: scale: default: null allOf: - $ref: '#/components/schemas/Scale' nullable: true showGridLines: default: null title: Showgridlines type: boolean nullable: true showTicks: default: null title: Showticks type: boolean nullable: true startAtZero: default: null description: Whether the Y axis should start at zero title: Startatzero type: boolean nullable: true title: YAxisSettings type: object ECODDetectorConfig: additionalProperties: false properties: preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: ecod title: Type type: string enum: - ecod window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: ECODDetectorConfig type: object RevenueAnalyticsOverviewQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/RevenueAnalyticsOverviewItem' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: RevenueAnalyticsOverviewQueryResponse type: object ErrorTrackingIssueAssignee: additionalProperties: false properties: id: anyOf: - type: string - type: integer title: Id type: $ref: '#/components/schemas/ErrorTrackingIssueAssigneeType' required: - id - type title: ErrorTrackingIssueAssignee type: object ClickhouseQueryProgress: additionalProperties: false properties: active_cpu_time: title: Active Cpu Time type: integer bytes_read: title: Bytes Read type: integer estimated_rows_total: title: Estimated Rows Total type: integer rows_read: title: Rows Read type: integer time_elapsed: title: Time Elapsed type: integer required: - active_cpu_time - bytes_read - estimated_rows_total - rows_read - time_elapsed title: ClickhouseQueryProgress type: object ActionConversionGoal: additionalProperties: false properties: actionId: title: Actionid type: integer required: - actionId title: ActionConversionGoal type: object NonIntegratedConversionsTableQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null description: Compare to date range allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true draftConversionGoal: default: null description: Draft conversion goal that can be set in the UI without saving title: Draftconversiongoal anyOf: - $ref: '#/components/schemas/ConversionGoalFilter1' - $ref: '#/components/schemas/ConversionGoalFilter2' - $ref: '#/components/schemas/ConversionGoalFilter3' nullable: true filterTestAccounts: default: null description: Filter test accounts title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: NonIntegratedConversionsTableQuery title: Kind type: string enum: - NonIntegratedConversionsTableQuery limit: default: null description: Number of rows to return title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null description: Number of rows to skip before returning rows title: Offset type: integer nullable: true orderBy: default: null description: Columns to order by title: Orderby items: items: anyOf: - type: string - $ref: '#/components/schemas/MarketingAnalyticsOrderByEnum' type: array type: array nullable: true properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/NonIntegratedConversionsTableQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true select: default: null description: Return a limited set of data. Will use default columns if empty. title: Select items: type: string type: array nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - properties title: NonIntegratedConversionsTableQuery type: object RetentionEntity: additionalProperties: false properties: aggregation_target_field: default: null description: Data warehouse field used as the actor identifier title: Aggregation Target Field type: string nullable: true custom_name: default: null title: Custom Name type: string nullable: true id: default: null title: Id anyOf: - type: string - type: number nullable: true kind: default: null allOf: - $ref: '#/components/schemas/RetentionEntityKind' nullable: true name: default: null title: Name type: string nullable: true order: default: null title: Order type: integer nullable: true properties: default: null description: filters on the event title: Properties items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array nullable: true table_name: default: null description: Data warehouse table name title: Table Name type: string nullable: true timestamp_field: default: null description: Data warehouse timestamp field title: Timestamp Field type: string nullable: true type: default: null allOf: - $ref: '#/components/schemas/EntityType' nullable: true uuid: default: null title: Uuid type: string nullable: true title: RetentionEntity type: object HogQLVariable: additionalProperties: false properties: code_name: title: Code Name type: string isNull: default: null title: Isnull type: boolean nullable: true value: default: null title: Value nullable: true variableId: title: Variableid type: string required: - code_name - variableId title: HogQLVariable type: object TrendsFilter: additionalProperties: false properties: aggregationAxisFormat: default: numeric allOf: - $ref: '#/components/schemas/AggregationAxisFormat' nullable: true aggregationAxisPostfix: default: null title: Aggregationaxispostfix type: string nullable: true aggregationAxisPrefix: default: null title: Aggregationaxisprefix type: string nullable: true breakdown_histogram_bin_count: default: null title: Breakdown Histogram Bin Count type: number nullable: true confidenceLevel: default: null title: Confidencelevel type: number nullable: true decimalPlaces: default: null title: Decimalplaces type: number nullable: true detailedResultsAggregationType: default: null description: detailed results table allOf: - $ref: '#/components/schemas/DetailedResultsAggregationType' nullable: true display: default: ActionsLineGraph allOf: - $ref: '#/components/schemas/ChartDisplayType' nullable: true excludeBoxPlotOutliers: default: true title: Excludeboxplotoutliers type: boolean nullable: true formula: default: null title: Formula type: string nullable: true formulaNodes: default: null description: List of formulas with optional custom names. Takes precedence over formula/formulas if set. title: Formulanodes items: $ref: '#/components/schemas/TrendsFormulaNode' type: array nullable: true formulas: default: null title: Formulas items: type: string type: array nullable: true goalLines: default: null description: Goal Lines title: Goallines items: $ref: '#/components/schemas/GoalLine' type: array nullable: true hiddenLegendIndexes: default: null title: Hiddenlegendindexes items: type: integer type: array nullable: true hideWeekends: default: false title: Hideweekends type: boolean nullable: true minDecimalPlaces: default: null title: Mindecimalplaces type: number nullable: true movingAverageIntervals: default: null title: Movingaverageintervals type: number nullable: true resultCustomizationBy: default: value description: Wether result datasets are associated by their values or by their order. allOf: - $ref: '#/components/schemas/ResultCustomizationBy' nullable: true resultCustomizations: default: null description: Customizations for the appearance of result datasets. title: Resultcustomizations anyOf: - additionalProperties: $ref: '#/components/schemas/ResultCustomizationByValue' type: object - additionalProperties: $ref: '#/components/schemas/ResultCustomizationByPosition' type: object nullable: true showAlertThresholdLines: default: false title: Showalertthresholdlines type: boolean nullable: true showConfidenceIntervals: default: null title: Showconfidenceintervals type: boolean nullable: true showLabelsOnSeries: default: null title: Showlabelsonseries type: boolean nullable: true showLegend: default: false title: Showlegend type: boolean nullable: true showMovingAverage: default: null title: Showmovingaverage type: boolean nullable: true showMultipleYAxes: default: false title: Showmultipleyaxes type: boolean nullable: true showPercentStackView: default: false title: Showpercentstackview type: boolean nullable: true showTrendLines: default: null title: Showtrendlines type: boolean nullable: true showValuesOnSeries: default: false title: Showvaluesonseries type: boolean nullable: true smoothingIntervals: default: 1 title: Smoothingintervals type: integer nullable: true yAxisScaleType: default: linear allOf: - $ref: '#/components/schemas/YAxisScaleType' nullable: true title: TrendsFilter type: object WebVitalsPathBreakdownQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation - not used in Web Analytics but required for type compatibility title: Aggregation Group Type Index type: integer nullable: true compareFilter: default: null allOf: - $ref: '#/components/schemas/CompareFilter' nullable: true conversionGoal: default: null title: Conversiongoal anyOf: - $ref: '#/components/schemas/ActionConversionGoal' - $ref: '#/components/schemas/CustomEventConversionGoal' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization - not used in Web Analytics but required for type compatibility title: Datacolortheme type: number nullable: true dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true doPathCleaning: default: null title: Dopathcleaning type: boolean nullable: true filterTestAccounts: default: null title: Filtertestaccounts type: boolean nullable: true includeRevenue: default: null title: Includerevenue type: boolean nullable: true interval: default: null description: Interval for date range calculation (affects date_to rounding for hour vs day ranges) allOf: - $ref: '#/components/schemas/IntervalType' nullable: true kind: default: WebVitalsPathBreakdownQuery title: Kind type: string enum: - WebVitalsPathBreakdownQuery metric: $ref: '#/components/schemas/WebVitalsMetric' modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true orderBy: default: null title: Orderby items: anyOf: - $ref: '#/components/schemas/WebAnalyticsOrderByFields' - $ref: '#/components/schemas/WebAnalyticsOrderByDirection' type: array nullable: true percentile: $ref: '#/components/schemas/WebVitalsPercentile' properties: type: array items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/WebVitalsPathBreakdownQueryResponse' nullable: true sampling: default: null allOf: - $ref: '#/components/schemas/WebAnalyticsSampling' nullable: true samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true thresholds: items: type: number maxItems: 2 minItems: 2 title: Thresholds type: array useSessionsTable: default: null title: Usesessionstable type: boolean nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - metric - percentile - properties - thresholds title: WebVitalsPathBreakdownQuery type: object LifecycleQueryResponse: additionalProperties: false properties: error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: additionalProperties: true type: object title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: LifecycleQueryResponse type: object PatchedInsight: type: object description: Simplified serializer to speed response times when loading large amounts of objects. properties: id: type: integer readOnly: true short_id: type: string readOnly: true name: type: string nullable: true maxLength: 400 derived_name: type: string nullable: true maxLength: 400 query: allOf: - $ref: '#/components/schemas/_InsightQuerySchema' nullable: true order: type: integer maximum: 2147483647 minimum: -2147483648 nullable: true deleted: type: boolean 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 " 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_refresh: type: string format: date-time nullable: true 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 " cache_target_age: type: string format: date-time nullable: true readOnly: true description: The target age of the cached results for this insight. next_allowed_client_refresh: type: string format: date-time nullable: true 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 " result: readOnly: true hasMore: type: boolean nullable: true readOnly: true columns: type: array items: type: string nullable: true readOnly: true created_at: type: string format: date-time readOnly: true nullable: true created_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true description: type: string nullable: true maxLength: 400 updated_at: type: string format: date-time readOnly: true tags: type: array items: {} favorited: type: boolean last_modified_at: type: string format: date-time readOnly: true last_modified_by: allOf: - $ref: '#/components/schemas/UserBasic' readOnly: true is_sample: type: boolean readOnly: true effective_restriction_level: allOf: - $ref: '#/components/schemas/EffectivePrivilegeLevelEnum' readOnly: true effective_privilege_level: allOf: - $ref: '#/components/schemas/EffectivePrivilegeLevelEnum' readOnly: true user_access_level: type: string nullable: true readOnly: true description: The effective access level the user has for this object timezone: type: string nullable: true readOnly: true description: The timezone this chart is displayed in. is_cached: type: boolean readOnly: true query_status: readOnly: true hogql: type: string nullable: true readOnly: true types: type: array items: {} nullable: true readOnly: true resolved_date_range: type: object nullable: true properties: date_from: type: string format: date-time date_to: type: string format: date-time readOnly: true _create_in_folder: type: string writeOnly: true title: ' create in folder' alerts: type: array items: {} readOnly: true last_viewed_at: type: string format: date-time nullable: true readOnly: true LLMTraceEvent: additionalProperties: false properties: createdAt: title: Createdat type: string event: anyOf: - $ref: '#/components/schemas/AIEventType' - type: string title: Event id: title: Id type: string properties: type: object additionalProperties: true title: Properties required: - createdAt - event - id - properties title: LLMTraceEvent type: object DataWarehousePropertyFilter: additionalProperties: false properties: key: title: Key type: string label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: data_warehouse title: Type type: string enum: - data_warehouse value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: DataWarehousePropertyFilter type: object SessionTableVersion: enum: - auto - v1 - v2 - v3 title: SessionTableVersion type: string LifecycleFilter: additionalProperties: false properties: showLegend: default: false title: Showlegend type: boolean nullable: true showValuesOnSeries: default: null title: Showvaluesonseries type: boolean nullable: true stacked: default: true title: Stacked type: boolean nullable: true toggledLifecycles: default: null title: Toggledlifecycles items: $ref: '#/components/schemas/LifecycleToggle' type: array nullable: true title: LifecycleFilter type: object KNNDetectorConfig: additionalProperties: false properties: method: default: null description: 'Distance method: ''largest'', ''mean'', ''median'' (default: ''largest'')' allOf: - $ref: '#/components/schemas/Method' nullable: true n_neighbors: default: null description: 'Number of neighbors to consider (default: 5)' title: N Neighbors type: integer nullable: true preprocessing: default: null description: Preprocessing transforms applied before detection allOf: - $ref: '#/components/schemas/PreprocessingConfig' nullable: true threshold: default: null description: 'Anomaly probability threshold (default: 0.9)' title: Threshold type: number nullable: true type: default: knn title: Type type: string enum: - knn window: default: null description: 'Rolling window size — how many historical data points to train on (default: based on calculation interval)' title: Window type: integer nullable: true title: KNNDetectorConfig type: object Response11: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response11 type: object AlertCheckStateEnum: enum: - Firing - Not firing - Errored - Snoozed type: string description: '* `Firing` - Firing * `Not firing` - Not firing * `Errored` - Errored * `Snoozed` - Snoozed' DataWarehouseEventsModifier: additionalProperties: false properties: distinct_id_field: title: Distinct Id Field type: string id_field: title: Id Field type: string table_name: title: Table Name type: string timestamp_field: title: Timestamp Field type: string required: - distinct_id_field - id_field - table_name - timestamp_field title: DataWarehouseEventsModifier type: object ColorMode: enum: - light - dark title: ColorMode type: string RevenueExampleDataWarehouseTablesQuery: additionalProperties: false properties: kind: default: RevenueExampleDataWarehouseTablesQuery title: Kind type: string enum: - RevenueExampleDataWarehouseTablesQuery limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true response: default: null allOf: - $ref: '#/components/schemas/RevenueExampleDataWarehouseTablesQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true title: RevenueExampleDataWarehouseTablesQuery type: object InvestigationStatusEnum: enum: - pending - running - done - failed - skipped type: string description: '* `pending` - pending * `running` - running * `done` - done * `failed` - failed * `skipped` - skipped' Response9: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: title: Results timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response9 type: object Response21: additionalProperties: false properties: columns: default: null title: Columns items: type: string type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: $ref: '#/components/schemas/ErrorTrackingIssue' title: Results type: array timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true required: - results title: Response21 type: object ExperimentVariantTrendsBaseStats: additionalProperties: false properties: absolute_exposure: title: Absolute Exposure type: number count: title: Count type: number exposure: title: Exposure type: number key: title: Key type: string required: - absolute_exposure - count - exposure - key title: ExperimentVariantTrendsBaseStats type: object RetentionValue: additionalProperties: false properties: aggregation_value: default: null title: Aggregation Value type: number nullable: true count: title: Count type: number label: default: null title: Label type: string nullable: true required: - count title: RetentionValue type: object FunnelLayout: enum: - horizontal - vertical title: FunnelLayout type: string ExperimentTrendsQueryResponse: additionalProperties: false properties: count_query: default: null allOf: - $ref: '#/components/schemas/TrendsQuery' nullable: true credible_intervals: additionalProperties: items: type: number type: array title: Credible Intervals type: object exposure_query: default: null allOf: - $ref: '#/components/schemas/TrendsQuery' nullable: true insight: items: additionalProperties: true type: object title: Insight type: array kind: default: ExperimentTrendsQuery title: Kind type: string enum: - ExperimentTrendsQuery p_value: title: P Value type: number probability: additionalProperties: type: number title: Probability type: object significance_code: $ref: '#/components/schemas/ExperimentSignificanceCode' significant: title: Significant type: boolean stats_version: default: null title: Stats Version type: integer nullable: true variants: items: $ref: '#/components/schemas/ExperimentVariantTrendsBaseStats' title: Variants type: array required: - credible_intervals - insight - p_value - probability - significance_code - significant - variants title: ExperimentTrendsQueryResponse type: object ExperimentRetentionMetric: additionalProperties: false properties: breakdownFilter: default: null allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true completion_event: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Completion Event conversion_window: default: null title: Conversion Window type: integer nullable: true conversion_window_unit: default: null allOf: - $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' nullable: true fingerprint: default: null title: Fingerprint type: string nullable: true goal: default: null allOf: - $ref: '#/components/schemas/ExperimentMetricGoal' nullable: true isSharedMetric: default: null title: Issharedmetric type: boolean nullable: true kind: default: ExperimentMetric title: Kind type: string enum: - ExperimentMetric metric_type: default: retention title: Metric Type type: string enum: - retention name: default: null title: Name type: string nullable: true response: default: null title: Response additionalProperties: true type: object nullable: true retention_window_end: title: Retention Window End type: integer retention_window_start: title: Retention Window Start type: integer retention_window_unit: $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' sharedMetricId: default: null title: Sharedmetricid type: number nullable: true start_event: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/ActionsNode' - $ref: '#/components/schemas/ExperimentDataWarehouseNode' title: Start Event start_handling: $ref: '#/components/schemas/StartHandling' uuid: default: null title: Uuid type: string nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - completion_event - retention_window_end - retention_window_start - retention_window_unit - start_event - start_handling title: ExperimentRetentionMetric type: object Response24: additionalProperties: false properties: count_query: default: null allOf: - $ref: '#/components/schemas/TrendsQuery' nullable: true credible_intervals: additionalProperties: items: type: number type: array title: Credible Intervals type: object exposure_query: default: null allOf: - $ref: '#/components/schemas/TrendsQuery' nullable: true insight: items: additionalProperties: true type: object title: Insight type: array kind: default: ExperimentTrendsQuery title: Kind type: string enum: - ExperimentTrendsQuery p_value: title: P Value type: number probability: additionalProperties: type: number title: Probability type: object significance_code: $ref: '#/components/schemas/ExperimentSignificanceCode' significant: title: Significant type: boolean stats_version: default: null title: Stats Version type: integer nullable: true variants: items: $ref: '#/components/schemas/ExperimentVariantTrendsBaseStats' title: Variants type: array required: - credible_intervals - insight - p_value - probability - significance_code - significant - variants title: Response24 type: object FunnelsFilter: additionalProperties: false properties: binCount: default: null title: Bincount type: integer nullable: true breakdownAttributionType: default: first_touch allOf: - $ref: '#/components/schemas/BreakdownAttributionType' nullable: true breakdownAttributionValue: default: null title: Breakdownattributionvalue type: integer nullable: true breakdownSorting: default: null description: 'Breakdown table sorting. Format: ''column_key'' or ''-column_key'' (descending)' title: Breakdownsorting type: string nullable: true customAggregationTarget: default: null description: For data warehouse based funnel insights when the aggregation target can't be mapped to persons or groups. title: Customaggregationtarget type: boolean nullable: true exclusions: default: [] title: Exclusions items: anyOf: - $ref: '#/components/schemas/FunnelExclusionEventsNode' - $ref: '#/components/schemas/FunnelExclusionActionsNode' type: array nullable: true funnelAggregateByHogQL: default: null title: Funnelaggregatebyhogql type: string nullable: true funnelFromStep: default: null title: Funnelfromstep type: integer nullable: true funnelOrderType: default: ordered allOf: - $ref: '#/components/schemas/StepOrderValue' nullable: true funnelStepReference: default: total allOf: - $ref: '#/components/schemas/FunnelStepReference' nullable: true funnelToStep: default: null description: To select the range of steps for trends & time to convert funnels, 0-indexed title: Funneltostep type: integer nullable: true funnelVizType: default: steps allOf: - $ref: '#/components/schemas/FunnelVizType' nullable: true funnelWindowInterval: default: 14 title: Funnelwindowinterval type: integer nullable: true funnelWindowIntervalUnit: default: day allOf: - $ref: '#/components/schemas/FunnelConversionWindowTimeUnit' nullable: true goalLines: default: null description: Goal Lines title: Goallines items: $ref: '#/components/schemas/GoalLine' type: array nullable: true hiddenLegendBreakdowns: default: null title: Hiddenlegendbreakdowns items: type: string type: array nullable: true layout: default: vertical allOf: - $ref: '#/components/schemas/FunnelLayout' nullable: true resultCustomizations: default: null description: Customizations for the appearance of result datasets. title: Resultcustomizations additionalProperties: $ref: '#/components/schemas/ResultCustomizationByValue' type: object nullable: true showTrendLines: default: null description: Display linear regression trend lines on the chart (only for historical trends viz) title: Showtrendlines type: boolean nullable: true showValuesOnSeries: default: false title: Showvaluesonseries type: boolean nullable: true useUdf: default: null title: Useudf type: boolean nullable: true title: FunnelsFilter type: object Method: enum: - largest - mean - median title: Method type: string RetentionQuery: additionalProperties: false properties: aggregation_group_type_index: default: null description: Groups aggregation title: Aggregation Group Type Index type: integer nullable: true breakdownFilter: default: null description: Breakdown of the events and actions allOf: - $ref: '#/components/schemas/BreakdownFilter' nullable: true dataColorTheme: default: null description: Colors used in the insight's visualization title: Datacolortheme type: number nullable: true dateRange: default: null description: Date range for the query allOf: - $ref: '#/components/schemas/DateRange' nullable: true filterTestAccounts: default: false description: Exclude internal and test users by applying the respective filters title: Filtertestaccounts type: boolean nullable: true kind: default: RetentionQuery title: Kind type: string enum: - RetentionQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: default: [] description: Property filters for all series title: Properties anyOf: - items: anyOf: - $ref: '#/components/schemas/EventPropertyFilter' - $ref: '#/components/schemas/PersonPropertyFilter' - $ref: '#/components/schemas/ElementPropertyFilter' - $ref: '#/components/schemas/EventMetadataPropertyFilter' - $ref: '#/components/schemas/SessionPropertyFilter' - $ref: '#/components/schemas/CohortPropertyFilter' - $ref: '#/components/schemas/RecordingPropertyFilter' - $ref: '#/components/schemas/LogEntryPropertyFilter' - $ref: '#/components/schemas/GroupPropertyFilter' - $ref: '#/components/schemas/FeaturePropertyFilter' - $ref: '#/components/schemas/FlagPropertyFilter' - $ref: '#/components/schemas/HogQLPropertyFilter' - $ref: '#/components/schemas/EmptyPropertyFilter' - $ref: '#/components/schemas/DataWarehousePropertyFilter' - $ref: '#/components/schemas/DataWarehousePersonPropertyFilter' - $ref: '#/components/schemas/ErrorTrackingIssueFilter' - $ref: '#/components/schemas/LogPropertyFilter' - $ref: '#/components/schemas/SpanPropertyFilter' - $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' - $ref: '#/components/schemas/WorkflowVariablePropertyFilter' type: array - $ref: '#/components/schemas/PropertyGroupFilter' nullable: true response: default: null allOf: - $ref: '#/components/schemas/RetentionQueryResponse' nullable: true retentionFilter: description: Properties specific to the retention insight allOf: - $ref: '#/components/schemas/RetentionFilter' samplingFactor: default: null description: Sampling rate title: Samplingfactor type: number nullable: true tags: default: null description: Tags that will be added to the Query log comment allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - retentionFilter title: RetentionQuery type: object Response5: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: {} title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true usedPreAggregatedTables: default: null title: Usedpreaggregatedtables type: boolean nullable: true required: - results title: Response5 type: object ErrorTrackingIssueAggregations: additionalProperties: false properties: occurrences: title: Occurrences type: number sessions: title: Sessions type: number users: title: Users type: number volumeRange: default: null title: Volumerange items: type: number type: array nullable: true volume_buckets: items: $ref: '#/components/schemas/VolumeBucket' title: Volume Buckets type: array required: - occurrences - sessions - users - volume_buckets title: ErrorTrackingIssueAggregations type: object DataTableNode: additionalProperties: false properties: allowSorting: default: null description: 'Can the user click on column headers to sort the table? (default: true)' title: Allowsorting type: boolean nullable: true columns: default: null description: Columns shown in the table, unless the `source` provides them. title: Columns items: type: string type: array nullable: true context: default: null description: Context for the table, used by components like ColumnConfigurator allOf: - $ref: '#/components/schemas/DataTableNodeViewPropsContext' nullable: true contextKey: default: null description: Context key for universal column configuration (e.g., "survey:123") title: Contextkey type: string nullable: true defaultColumns: default: null description: Default columns to use when resetting column configuration title: Defaultcolumns items: type: string type: array nullable: true embedded: default: null description: Uses the embedded version of LemonTable title: Embedded type: boolean nullable: true expandable: default: null description: 'Can expand row to show raw event data (default: true)' title: Expandable type: boolean nullable: true full: default: null description: Show with most visual options enabled. Used in scenes. title: Full type: boolean nullable: true hiddenColumns: default: null description: Columns that aren't shown in the table, even if in columns or returned data title: Hiddencolumns items: type: string type: array nullable: true kind: default: DataTableNode title: Kind type: string enum: - DataTableNode pinnedColumns: default: null description: Columns that are sticky when scrolling horizontally title: Pinnedcolumns items: type: string type: array nullable: true propertiesViaUrl: default: null description: 'Link properties via the URL (default: false)' title: Propertiesviaurl type: boolean nullable: true response: default: null title: Response anyOf: - additionalProperties: true type: object - $ref: '#/components/schemas/Response' - $ref: '#/components/schemas/Response1' - $ref: '#/components/schemas/Response2' - $ref: '#/components/schemas/Response3' - $ref: '#/components/schemas/Response4' - $ref: '#/components/schemas/Response5' - $ref: '#/components/schemas/Response6' - $ref: '#/components/schemas/Response8' - $ref: '#/components/schemas/Response9' - $ref: '#/components/schemas/Response10' - $ref: '#/components/schemas/Response11' - $ref: '#/components/schemas/Response12' - $ref: '#/components/schemas/Response13' - $ref: '#/components/schemas/Response14' - $ref: '#/components/schemas/Response15' - $ref: '#/components/schemas/Response16' - $ref: '#/components/schemas/Response18' - $ref: '#/components/schemas/Response19' - $ref: '#/components/schemas/Response20' - $ref: '#/components/schemas/Response21' - $ref: '#/components/schemas/Response22' - $ref: '#/components/schemas/Response23' - $ref: '#/components/schemas/Response24' - $ref: '#/components/schemas/Response25' - $ref: '#/components/schemas/Response26' nullable: true showActions: default: null description: Show the kebab menu at the end of the row title: Showactions type: boolean nullable: true showColumnConfigurator: default: null description: Show a button to configure the table's columns if possible title: Showcolumnconfigurator type: boolean nullable: true showCount: default: null description: Show count of total and filtered results title: Showcount type: boolean nullable: true showDateRange: default: null description: Show date range selector title: Showdaterange type: boolean nullable: true showElapsedTime: default: null description: Show the time it takes to run a query title: Showelapsedtime type: boolean nullable: true showEventFilter: default: null description: Include an event filter above the table (EventsNode only) title: Showeventfilter type: boolean nullable: true showEventsFilter: default: null description: Include an events filter above the table to filter by multiple events (EventsQuery only) title: Showeventsfilter type: boolean nullable: true showExport: default: null description: Show the export button title: Showexport type: boolean nullable: true showHogQLEditor: default: null description: Include a HogQL query editor above HogQL tables title: Showhogqleditor type: boolean nullable: true showOpenEditorButton: default: null description: 'Show a button to open the current query as a new insight. (default: true)' title: Showopeneditorbutton type: boolean nullable: true showPersistentColumnConfigurator: default: null description: Show a button to configure and persist the table's default columns if possible title: Showpersistentcolumnconfigurator type: boolean nullable: true showPropertyFilter: default: null description: Include a property filter above the table title: Showpropertyfilter anyOf: - type: boolean - items: $ref: '#/components/schemas/TaxonomicFilterGroupType' type: array nullable: true showRecordingColumn: default: null description: Show a recording column for events with session recordings title: Showrecordingcolumn type: boolean nullable: true showReload: default: null description: Show a reload button title: Showreload type: boolean nullable: true showResultsTable: default: null description: Show a results table title: Showresultstable type: boolean nullable: true showSavedFilters: default: null description: Show saved filters feature for this table (requires uniqueKey) title: Showsavedfilters type: boolean nullable: true showSavedQueries: default: null description: Shows a list of saved queries title: Showsavedqueries type: boolean nullable: true showSearch: default: null description: Include a free text search field (PersonsNode only) title: Showsearch type: boolean nullable: true showSourceQueryOptions: default: null description: Show actors query options and back to source title: Showsourcequeryoptions type: boolean nullable: true showTableViews: default: null description: Show table views feature for this table (requires uniqueKey) title: Showtableviews type: boolean nullable: true showTestAccountFilters: default: null description: Show filter to exclude test accounts title: Showtestaccountfilters type: boolean nullable: true showTimings: default: null description: Show a detailed query timing breakdown title: Showtimings type: boolean nullable: true source: anyOf: - $ref: '#/components/schemas/EventsNode' - $ref: '#/components/schemas/EventsQuery' - $ref: '#/components/schemas/PersonsNode' - $ref: '#/components/schemas/ActorsQuery' - $ref: '#/components/schemas/GroupsQuery' - $ref: '#/components/schemas/HogQLQuery' - $ref: '#/components/schemas/WebOverviewQuery' - $ref: '#/components/schemas/WebStatsTableQuery' - $ref: '#/components/schemas/WebExternalClicksTableQuery' - $ref: '#/components/schemas/WebGoalsQuery' - $ref: '#/components/schemas/WebVitalsQuery' - $ref: '#/components/schemas/WebVitalsPathBreakdownQuery' - $ref: '#/components/schemas/SessionAttributionExplorerQuery' - $ref: '#/components/schemas/SessionsQuery' - $ref: '#/components/schemas/RevenueAnalyticsGrossRevenueQuery' - $ref: '#/components/schemas/RevenueAnalyticsMetricsQuery' - $ref: '#/components/schemas/RevenueAnalyticsMRRQuery' - $ref: '#/components/schemas/RevenueAnalyticsOverviewQuery' - $ref: '#/components/schemas/RevenueAnalyticsTopCustomersQuery' - $ref: '#/components/schemas/RevenueExampleEventsQuery' - $ref: '#/components/schemas/RevenueExampleDataWarehouseTablesQuery' - $ref: '#/components/schemas/MarketingAnalyticsTableQuery' - $ref: '#/components/schemas/MarketingAnalyticsAggregatedQuery' - $ref: '#/components/schemas/NonIntegratedConversionsTableQuery' - $ref: '#/components/schemas/ErrorTrackingQuery' - $ref: '#/components/schemas/ErrorTrackingIssueCorrelationQuery' - $ref: '#/components/schemas/ExperimentFunnelsQuery' - $ref: '#/components/schemas/ExperimentTrendsQuery' - $ref: '#/components/schemas/TracesQuery' - $ref: '#/components/schemas/TraceQuery' - $ref: '#/components/schemas/EndpointsUsageTableQuery' description: Source of the events title: Source tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - source title: DataTableNode type: object RecordingPropertyFilter: additionalProperties: false properties: key: anyOf: - $ref: '#/components/schemas/DurationType' - type: string title: Key label: default: null title: Label type: string nullable: true operator: $ref: '#/components/schemas/PropertyOperator' type: default: recording title: Type type: string enum: - recording value: default: null title: Value anyOf: - items: anyOf: - type: string - type: number - type: boolean type: array - type: string - type: number - type: boolean nullable: true required: - key - operator title: RecordingPropertyFilter type: object PreprocessingConfig: additionalProperties: false properties: diffs_n: default: null description: 'Order of differencing. 0 = raw values, 1 = first-order diffs (default: 0)' title: Diffs N type: integer nullable: true lags_n: default: null description: 'Number of lag features. 0 = none, >0 = include n lagged values (default: 0)' title: Lags N type: integer nullable: true smooth_n: default: null description: 'Moving average window size. 0 = no smoothing, >1 = smooth over n points (default: 0)' title: Smooth N type: integer nullable: true title: PreprocessingConfig type: object BreakdownFilter: additionalProperties: false properties: breakdown: default: null title: Breakdown anyOf: - type: string - items: anyOf: - type: string - type: integer type: array - type: integer nullable: true breakdown_group_type_index: default: null title: Breakdown Group Type Index type: integer nullable: true breakdown_hide_other_aggregation: default: null title: Breakdown Hide Other Aggregation type: boolean nullable: true breakdown_histogram_bin_count: default: null title: Breakdown Histogram Bin Count type: integer nullable: true breakdown_limit: default: null title: Breakdown Limit type: integer nullable: true breakdown_normalize_url: default: null title: Breakdown Normalize Url type: boolean nullable: true breakdown_path_cleaning: default: null title: Breakdown Path Cleaning type: boolean nullable: true breakdown_type: default: event allOf: - $ref: '#/components/schemas/BreakdownType' nullable: true breakdowns: default: null title: Breakdowns items: $ref: '#/components/schemas/Breakdown' maxItems: 3 type: array nullable: true title: BreakdownFilter type: object ActionsPie: additionalProperties: false properties: disableHoverOffset: default: null title: Disablehoveroffset type: boolean nullable: true hideAggregation: default: null title: Hideaggregation type: boolean nullable: true title: ActionsPie type: object RevenueAnalyticsGrossRevenueQuery: additionalProperties: false properties: breakdown: items: $ref: '#/components/schemas/RevenueAnalyticsBreakdown' title: Breakdown type: array dateRange: default: null allOf: - $ref: '#/components/schemas/DateRange' nullable: true interval: $ref: '#/components/schemas/SimpleIntervalType' kind: default: RevenueAnalyticsGrossRevenueQuery title: Kind type: string enum: - RevenueAnalyticsGrossRevenueQuery modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true properties: type: array items: $ref: '#/components/schemas/RevenueAnalyticsPropertyFilter' title: Properties response: default: null allOf: - $ref: '#/components/schemas/RevenueAnalyticsGrossRevenueQueryResponse' nullable: true tags: default: null allOf: - $ref: '#/components/schemas/QueryLogTags' nullable: true version: default: null description: version of the node, used for schema migrations title: Version type: number nullable: true required: - breakdown - interval - properties title: RevenueAnalyticsGrossRevenueQuery type: object ExperimentVariantResultBayesian: additionalProperties: false properties: chance_to_win: default: null title: Chance To Win type: number nullable: true covariate_sum: default: null title: Covariate Sum type: number nullable: true covariate_sum_product: default: null title: Covariate Sum Product type: number nullable: true covariate_sum_squares: default: null title: Covariate Sum Squares type: number nullable: true credible_interval: default: null title: Credible Interval items: type: number maxItems: 2 minItems: 2 type: array nullable: true denominator_sum: default: null title: Denominator Sum type: number nullable: true denominator_sum_squares: default: null title: Denominator Sum Squares type: number nullable: true key: title: Key type: string method: default: bayesian title: Method type: string enum: - bayesian number_of_samples: title: Number Of Samples type: integer numerator_denominator_sum_product: default: null title: Numerator Denominator Sum Product type: number nullable: true significant: default: null title: Significant type: boolean nullable: true step_counts: default: null title: Step Counts items: type: integer type: array nullable: true step_sessions: default: null title: Step Sessions items: items: $ref: '#/components/schemas/SessionData' type: array type: array nullable: true sum: title: Sum type: number sum_squares: title: Sum Squares type: number validation_failures: default: null title: Validation Failures items: $ref: '#/components/schemas/ExperimentStatsValidationFailure' type: array nullable: true required: - key - number_of_samples - sum - sum_squares title: ExperimentVariantResultBayesian type: object RETENTION: additionalProperties: false properties: hideLineGraph: default: null title: Hidelinegraph type: boolean nullable: true hideSizeColumn: default: null title: Hidesizecolumn type: boolean nullable: true useSmallLayout: default: null title: Usesmalllayout type: boolean nullable: true title: RETENTION type: object Response20: additionalProperties: false properties: columns: default: null title: Columns items: {} type: array nullable: true error: default: null description: Query error. Returned only if 'explain' or `modifiers.debug` is true. Throws an error otherwise. title: Error type: string nullable: true hasMore: default: null title: Hasmore type: boolean nullable: true hogql: default: null description: Generated HogQL query. title: Hogql type: string nullable: true limit: default: null title: Limit type: integer nullable: true modifiers: default: null description: Modifiers used when performing the query allOf: - $ref: '#/components/schemas/HogQLQueryModifiers' nullable: true offset: default: null title: Offset type: integer nullable: true query_status: default: null description: Query status indicates whether next to the provided data, a query is still running. allOf: - $ref: '#/components/schemas/QueryStatus' nullable: true resolved_date_range: default: null description: The date range used for the query allOf: - $ref: '#/components/schemas/ResolvedDateRangeResponse' nullable: true results: items: items: $ref: '#/components/schemas/MarketingAnalyticsItem' type: array title: Results type: array samplingRate: default: null allOf: - $ref: '#/components/schemas/SamplingRate' nullable: true timings: default: null description: Measured timings for different parts of the query generation process title: Timings items: $ref: '#/components/schemas/QueryTiming' type: array nullable: true types: default: null title: Types items: {} type: array nullable: true required: - results title: Response20 type: object ThresholdWithAlert: type: object properties: id: type: string format: uuid readOnly: true created_at: type: string format: date-time readOnly: true name: type: string description: Optional name for the threshold. configuration: allOf: - $ref: '#/components/schemas/InsightThreshold' description: Threshold bounds and type. Includes bounds (lower/upper floats) and type (absolute or percentage). alerts: type: array items: $ref: '#/components/schemas/Alert' readOnly: true required: - alerts - configuration - created_at - id parameters: EnvironmentIdPath: in: path name: environment_id required: true schema: type: string description: Deprecated. Use /api/projects/{project_id}/ instead. ProjectIdPath: in: path name: project_id required: true schema: type: string description: Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. securitySchemes: PersonalAPIKeyAuth: type: http scheme: bearer x-tagGroups: - name: All endpoints tags: - LLM Analytics - actions - activity_log - activity_logs - advanced_activity_logs - alerts - annotations - approval_policies - batch_exports - cdp - change_requests - code - code-invites - cohorts - comments - conversations - core - customer_analytics - customer_journeys - customer_profile_configs - dashboard_templates - dashboards - data_color_themes - data_modeling_jobs - data_warehouse - dataset_items - datasets - desktop_recordings - domains - early_access_feature - early_access_features - elements - endpoints - environments - error_tracking - evaluation_runs - evaluations - event_definitions - event_filter - event_schemas - events - experiment_holdouts - experiment_saved_metrics - experiments - exports - external_data_schemas - external_data_sources - feature_flags - file_system - file_system_shortcut - flag_value - groups - groups_types - health_issues - heatmap_screenshots - heatmaps - hog_flows - hog_function_templates - hog_functions - insight_variables - insights - integrations - invites - js-snippet - legal_documents - lineage - live_debugger_breakpoints - llm_analytics - llm_prompts - llm_skills - logs - managed_viewsets - max - max_tools - mcp_server_installations - mcp_servers - mcp_store - mcp_tools - members - notebooks - oauth_applications - object_media_previews - organizations - persisted_folder - persons - platform_features - plugin_configs - product_analytics - product_tours - project_secret_api_keys - projects - property_definitions - proxy_records - public_hog_function_templates - query - replay - reverse_proxy - role_external_references - roles - sandbox-environments - sandbox_environments - saved - schema_property_groups - sdk_doctor - session_group_summaries - session_recording_playlists - session_recordings - session_summaries - sessions - signals - subscriptions - surveys - taggers - task-automations - task-runs - task_automations - tasks - uploaded_media - user_home_settings - user_interviews - users - visual_review - warehouse_dag - warehouse_model_paths - warehouse_saved_queries - warehouse_saved_query_folders - warehouse_tables - warehouse_view_link - warehouse_view_links - web_analytics - web_experiments - web_vitals - welcome - workflows