RestrictionLevelEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Everyone in the project can edit\n* `37` - Only those invited to this dashboard can edit"
}
RetentionEntity
{
"type": "object",
"title": "RetentionEntity",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"title": "Id",
"default": null,
"nullable": true
},
"kind": {
"$ref": "#/components/schemas/Kind1Nullable"
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EntityTypeNullable"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"order": {
"type": "integer",
"title": "Order",
"default": null,
"nullable": true
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
}
}
}
RetentionEntityNullable
{
"type": "object",
"title": "RetentionEntity",
"default": null,
"nullable": true,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
],
"title": "Id",
"default": null,
"nullable": true
},
"kind": {
"$ref": "#/components/schemas/Kind1Nullable"
},
"name": {
"type": "string",
"title": "Name",
"default": null,
"nullable": true
},
"type": {
"$ref": "#/components/schemas/EntityTypeNullable"
},
"uuid": {
"type": "string",
"title": "Uuid",
"default": null,
"nullable": true
},
"order": {
"type": "integer",
"title": "Order",
"default": null,
"nullable": true
},
"custom_name": {
"type": "string",
"title": "Custom Name",
"default": null,
"nullable": true
}
}
}
RetentionFilter
{
"type": "object",
"title": "RetentionFilter",
"properties": {
"period": {
"$ref": "#/components/schemas/RetentionPeriodNullable"
},
"targetEntity": {
"$ref": "#/components/schemas/RetentionEntityNullable"
},
"retentionType": {
"$ref": "#/components/schemas/RetentionTypeNullable"
},
"totalIntervals": {
"type": "integer",
"title": "Totalintervals",
"default": null,
"nullable": true
},
"returningEntity": {
"$ref": "#/components/schemas/RetentionEntityNullable"
},
"retentionReference": {
"$ref": "#/components/schemas/RetentionReferenceNullable"
}
}
}
RetentionPeriod
{
"enum": [
"Hour",
"Day",
"Week",
"Month"
],
"type": "string",
"title": "RetentionPeriod"
}
RetentionPeriodNullable
{
"enum": [
"Hour",
"Day",
"Week",
"Month"
],
"type": "string",
"title": "RetentionPeriod",
"default": null,
"nullable": true
}
RetentionQuery
{
"type": "object",
"title": "RetentionQuery",
"required": [
"retentionFilter"
],
"properties": {
"kind": {
"const": "RetentionQuery",
"title": "Kind",
"default": "RetentionQuery"
},
"response": {
"$ref": "#/components/schemas/RetentionQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"retentionFilter": {
"$ref": "#/components/schemas/RetentionFilter"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
},
"aggregation_group_type_index": {
"type": "integer",
"title": "Aggregation Group Type Index",
"default": null,
"nullable": true,
"description": "Groups aggregation"
}
},
"x-konfig-properties": {
"retentionFilter": {
"description": "Properties specific to the retention insight"
}
}
}
RetentionQueryResponse
{
"type": "object",
"title": "RetentionQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionResult"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
RetentionQueryResponseNullable
{
"type": "object",
"title": "RetentionQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionResult"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
RetentionReference
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "RetentionReference"
}
RetentionReferenceNullable
{
"enum": [
"total",
"previous"
],
"type": "string",
"title": "RetentionReference",
"default": null,
"nullable": true
}
RetentionResult
{
"type": "object",
"title": "RetentionResult",
"required": [
"date",
"label",
"values"
],
"properties": {
"date": {
"type": "string",
"title": "Date",
"format": "date-time"
},
"label": {
"type": "string",
"title": "Label"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RetentionValue"
},
"title": "Values"
}
}
}
RetentionType
{
"enum": [
"retention_recurring",
"retention_first_time"
],
"type": "string",
"title": "RetentionType"
}
RetentionTypeNullable
{
"enum": [
"retention_recurring",
"retention_first_time"
],
"type": "string",
"title": "RetentionType",
"default": null,
"nullable": true
}
RetentionValue
{
"type": "object",
"title": "RetentionValue",
"required": [
"count"
],
"properties": {
"count": {
"type": "integer",
"title": "Count"
}
}
}
Role
{
"type": "object",
"required": [
"associated_flags",
"created_at",
"created_by",
"id",
"members",
"name"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"members": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"associated_flags": {
"type": "string",
"readOnly": true
},
"feature_flags_access_level": {
"$ref": "#/components/schemas/FeatureFlagsAccessLevelEnum"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flags_access_level": {
"maximum": 32767,
"minimum": 0
}
}
}
RoleMembership
{
"type": "object",
"required": [
"id",
"joined_at",
"organization_member",
"role_id",
"updated_at",
"user",
"user_uuid"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"role_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_uuid": {
"type": "string",
"format": "uuid",
"writeOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"organization_member": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"organization_member": {
"readOnly": true
}
}
}
Sampling
{
"type": "object",
"title": "Sampling",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": null,
"nullable": true
},
"forceSamplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
}
}
}
SamplingNullable
{
"type": "object",
"title": "Sampling",
"default": null,
"nullable": true,
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": null,
"nullable": true
},
"forceSamplingRate": {
"$ref": "#/components/schemas/SamplingRateNullable"
}
}
}
SamplingRate
{
"type": "object",
"title": "SamplingRate",
"required": [
"numerator"
],
"properties": {
"numerator": {
"type": "number",
"title": "Numerator"
},
"denominator": {
"type": "number",
"title": "Denominator",
"default": null,
"nullable": true
}
}
}
SamplingRateNullable
{
"type": "object",
"title": "SamplingRate",
"default": null,
"nullable": true,
"required": [
"numerator"
],
"properties": {
"numerator": {
"type": "number",
"title": "Numerator"
},
"denominator": {
"type": "number",
"title": "Denominator",
"default": null,
"nullable": true
}
}
}
SavedInsightNode
{
"type": "object",
"title": "SavedInsightNode",
"required": [
"shortId"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in insight scene."
},
"kind": {
"const": "SavedInsightNode",
"title": "Kind",
"default": "SavedInsightNode"
},
"shortId": {
"type": "string",
"title": "Shortid"
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Query is embedded inside another bordered component"
},
"showTable": {
"type": "boolean",
"title": "Showtable",
"default": null,
"nullable": true
},
"expandable": {
"type": "boolean",
"title": "Expandable",
"default": null,
"nullable": true,
"description": "Can expand row to show raw event data (default: true)"
},
"showExport": {
"type": "boolean",
"title": "Showexport",
"default": null,
"nullable": true,
"description": "Show the export button"
},
"showHeader": {
"type": "boolean",
"title": "Showheader",
"default": null,
"nullable": true
},
"showReload": {
"type": "boolean",
"title": "Showreload",
"default": null,
"nullable": true,
"description": "Show a reload button"
},
"showSearch": {
"type": "boolean",
"title": "Showsearch",
"default": null,
"nullable": true,
"description": "Include a free text search field (PersonsNode only)"
},
"showActions": {
"type": "boolean",
"title": "Showactions",
"default": null,
"nullable": true,
"description": "Show the kebab menu at the end of the row"
},
"showFilters": {
"type": "boolean",
"title": "Showfilters",
"default": null,
"nullable": true
},
"showResults": {
"type": "boolean",
"title": "Showresults",
"default": null,
"nullable": true
},
"showTimings": {
"type": "boolean",
"title": "Showtimings",
"default": null,
"nullable": true,
"description": "Show a detailed query timing breakdown"
},
"allowSorting": {
"type": "boolean",
"title": "Allowsorting",
"default": null,
"nullable": true,
"description": "Can the user click on column headers to sort the table? (default: true)"
},
"showDateRange": {
"type": "boolean",
"title": "Showdaterange",
"default": null,
"nullable": true,
"description": "Show date range selector"
},
"showElapsedTime": {
"type": "boolean",
"title": "Showelapsedtime",
"default": null,
"nullable": true,
"description": "Show the time it takes to run a query"
},
"showEventFilter": {
"type": "boolean",
"title": "Showeventfilter",
"default": null,
"nullable": true,
"description": "Include an event filter above the table (EventsNode only)"
},
"showHogQLEditor": {
"type": "boolean",
"title": "Showhogqleditor",
"default": null,
"nullable": true,
"description": "Include a HogQL query editor above HogQL tables"
},
"hidePersonsModal": {
"type": "boolean",
"title": "Hidepersonsmodal",
"default": null,
"nullable": true
},
"propertiesViaUrl": {
"type": "boolean",
"title": "Propertiesviaurl",
"default": null,
"nullable": true,
"description": "Link properties via the URL (default: false)"
},
"showResultsTable": {
"type": "boolean",
"title": "Showresultstable",
"default": null,
"nullable": true,
"description": "Show a results table"
},
"showSavedQueries": {
"type": "boolean",
"title": "Showsavedqueries",
"default": null,
"nullable": true,
"description": "Shows a list of saved queries"
},
"showPropertyFilter": {
"type": "boolean",
"title": "Showpropertyfilter",
"default": null,
"nullable": true,
"description": "Include a property filter above the table"
},
"vizSpecificOptions": {
"$ref": "#/components/schemas/VizSpecificOptionsNullable"
},
"showLastComputation": {
"type": "boolean",
"title": "Showlastcomputation",
"default": null,
"nullable": true
},
"showCorrelationTable": {
"type": "boolean",
"title": "Showcorrelationtable",
"default": null,
"nullable": true
},
"showOpenEditorButton": {
"type": "boolean",
"title": "Showopeneditorbutton",
"default": null,
"nullable": true,
"description": "Show a button to open the current query as a new insight. (default: true)"
},
"showColumnConfigurator": {
"type": "boolean",
"title": "Showcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure the table's columns if possible"
},
"showTestAccountFilters": {
"type": "boolean",
"title": "Showtestaccountfilters",
"default": null,
"nullable": true,
"description": "Show filter to exclude test accounts"
},
"showLastComputationRefresh": {
"type": "boolean",
"title": "Showlastcomputationrefresh",
"default": null,
"nullable": true
},
"suppressSessionAnalysisWarning": {
"type": "boolean",
"title": "Suppresssessionanalysiswarning",
"default": null,
"nullable": true
},
"showPersistentColumnConfigurator": {
"type": "boolean",
"title": "Showpersistentcolumnconfigurator",
"default": null,
"nullable": true,
"description": "Show a button to configure and persist the table's default columns if possible"
}
}
}
ScenePersonalisationBasic
{
"type": "object",
"required": [
"scene"
],
"properties": {
"scene": {
"type": "string",
"maxLength": 200
},
"dashboard": {
"type": "integer",
"nullable": true
}
}
}
Series
{
"type": "object",
"title": "Series",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "integer",
"title": "Value"
}
}
}
SessionPropertyFilter
{
"type": "object",
"title": "SessionPropertyFilter",
"required": [
"key",
"operator"
],
"properties": {
"key": {
"type": "string",
"title": "Key"
},
"type": {
"const": "session",
"title": "Type",
"default": "session"
},
"label": {
"type": "string",
"title": "Label",
"default": null,
"nullable": true
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
],
"title": "Value",
"default": null,
"nullable": true
},
"operator": {
"$ref": "#/components/schemas/PropertyOperator"
}
}
}
SessionRecording
{
"type": "object",
"required": [
"active_seconds",
"click_count",
"console_error_count",
"console_log_count",
"console_warn_count",
"distinct_id",
"end_time",
"id",
"inactive_seconds",
"keypress_count",
"mouse_activity_count",
"recording_duration",
"start_time",
"start_url",
"storage",
"viewed"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"person": {
"$ref": "#/components/schemas/MinimalPerson"
},
"viewed": {
"type": "string",
"readOnly": true
},
"storage": {
"type": "string",
"readOnly": true
},
"end_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"start_url": {
"type": "string",
"nullable": true,
"readOnly": true
},
"start_time": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"click_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"distinct_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"active_seconds": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"keypress_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"inactive_seconds": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"console_log_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"console_warn_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"recording_duration": {
"type": "integer",
"readOnly": true
},
"console_error_count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"mouse_activity_count": {
"type": "integer",
"nullable": true,
"readOnly": true
}
}
}
SessionRecordingPlaylist
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"last_modified_at",
"last_modified_by",
"short_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"pinned": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
SessionrecordingsGetSharingResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
SessionsTimelineQuery
{
"type": "object",
"title": "SessionsTimelineQuery",
"properties": {
"kind": {
"const": "SessionsTimelineQuery",
"title": "Kind",
"default": "SessionsTimelineQuery"
},
"after": {
"type": "string",
"title": "After",
"default": null,
"nullable": true,
"description": "Only fetch sessions that started after this timestamp (default: '-24h')"
},
"before": {
"type": "string",
"title": "Before",
"default": null,
"nullable": true,
"description": "Only fetch sessions that started before this timestamp (default: '+5s')"
},
"personId": {
"type": "string",
"title": "Personid",
"default": null,
"nullable": true,
"description": "Fetch sessions only for a given person"
},
"response": {
"$ref": "#/components/schemas/SessionsTimelineQueryResponseNullable"
}
}
}
SessionsTimelineQueryResponse
{
"type": "object",
"title": "SessionsTimelineQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEntry"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
}
}
SessionsTimelineQueryResponseNullable
{
"type": "object",
"title": "SessionsTimelineQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"hasMore": {
"type": "boolean",
"title": "Hasmore",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TimelineEntry"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
}
},
"description": "Cached query response"
}
SharingConfiguration
{
"type": "object",
"required": [
"access_token",
"created_at"
],
"properties": {
"enabled": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"access_token": {
"type": "string",
"nullable": true,
"readOnly": true
}
}
}
SourceEnum
{
"enum": [
"SYSTEM",
"PLUGIN",
"CONSOLE"
],
"type": "string",
"description": "* `SYSTEM` - SYSTEM\n* `PLUGIN` - PLUGIN\n* `CONSOLE` - CONSOLE"
}
StageEnum
{
"enum": [
"draft",
"concept",
"alpha",
"beta",
"general-availability",
"archived"
],
"type": "string",
"description": "* `draft` - draft\n* `concept` - concept\n* `alpha` - alpha\n* `beta` - beta\n* `general-availability` - general availability\n* `archived` - archived"
}
StatusEnum
{
"enum": [
"Cancelled",
"Completed",
"ContinuedAsNew",
"Failed",
"FailedRetryable",
"Terminated",
"TimedOut",
"Running",
"Starting"
],
"type": "string",
"description": "* `Cancelled` - Cancelled\n* `Completed` - Completed\n* `ContinuedAsNew` - Continued As New\n* `Failed` - Failed\n* `FailedRetryable` - Failed Retryable\n* `Terminated` - Terminated\n* `TimedOut` - Timedout\n* `Running` - Running\n* `Starting` - Starting"
}
StatusItem
{
"type": "object",
"title": "StatusItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "string",
"title": "Value"
}
}
}
StepOrderValue
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"title": "StepOrderValue"
}
StepOrderValueNullable
{
"enum": [
"strict",
"unordered",
"ordered"
],
"type": "string",
"title": "StepOrderValue",
"default": null,
"nullable": true
}
StickinessFilter
{
"type": "object",
"title": "StickinessFilter",
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
}
}
}
StickinessFilterNullable
{
"type": "object",
"title": "StickinessFilter",
"default": null,
"nullable": true,
"properties": {
"compare": {
"type": "boolean",
"title": "Compare",
"default": null,
"nullable": true
},
"display": {
"$ref": "#/components/schemas/ChartDisplayTypeNullable"
},
"showLegend": {
"type": "boolean",
"title": "Showlegend",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
},
"hidden_legend_indexes": {
"type": "array",
"items": {
"type": "number"
},
"title": "Hidden Legend Indexes",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the stickiness insight"
}
StickinessQuery
{
"type": "object",
"title": "StickinessQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "StickinessQuery",
"title": "Kind",
"default": "StickinessQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"stickinessFilter": {
"$ref": "#/components/schemas/StickinessFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
}
}
}
Subscription
{
"type": "object",
"required": [
"created_at",
"created_by",
"frequency",
"id",
"next_delivery_date",
"start_date",
"summary",
"target_type",
"target_value"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 100
},
"deleted": {
"type": "boolean"
},
"insight": {
"type": "integer",
"nullable": true
},
"summary": {
"type": "string",
"readOnly": true
},
"bysetpos": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"interval": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"byweekday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ByweekdayEnum"
},
"nullable": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"frequency": {
"$ref": "#/components/schemas/FrequencyEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"until_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"target_type": {
"$ref": "#/components/schemas/TargetTypeEnum"
},
"target_value": {
"type": "string"
},
"invite_message": {
"type": "string",
"nullable": true
},
"next_delivery_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
}
},
"description": "Standard Subscription serializer.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
Survey
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"linked_flag",
"name",
"targeting_flag",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
SurveySerializerCreateUpdateOnly
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"linked_flag",
"name",
"targeting_flag",
"type"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true,
"writeOnly": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"targeting_flag_id": {
"type": "integer",
"writeOnly": true
},
"remove_targeting_flag": {
"type": "boolean",
"nullable": true,
"writeOnly": true
},
"targeting_flag_filters": {
"nullable": true,
"writeOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
TargetTypeEnum
{
"enum": [
"email",
"slack",
"webhook"
],
"type": "string",
"description": "* `email` - Email\n* `slack` - Slack\n* `webhook` - Webhook"
}
Team
{
"type": "object",
"required": [
"api_token",
"created_at",
"effective_membership_level",
"groups_on_events_querying_enabled",
"has_group_types",
"id",
"ingested_event",
"organization",
"person_on_events_querying_enabled",
"updated_at",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean"
},
"app_urls": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"anonymize_ips": {
"type": "boolean"
},
"access_control": {
"type": "boolean"
},
"extra_settings": {
"nullable": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"surveys_opt_in": {
"type": "boolean",
"nullable": true
},
"week_start_day": {
"oneOf": [
{
"$ref": "#/components/schemas/WeekStartDayEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"maximum": 32767,
"minimum": -32768,
"nullable": true
},
"data_attributes": {},
"has_group_types": {
"type": "boolean",
"readOnly": true
},
"inject_web_apps": {
"type": "boolean",
"nullable": true
},
"primary_dashboard": {
"type": "integer",
"nullable": true
},
"recording_domains": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"nullable": true
},
"correlation_config": {
"nullable": true
},
"autocapture_opt_out": {
"type": "boolean",
"nullable": true
},
"live_events_columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"test_account_filters": {},
"path_cleaning_filters": {
"nullable": true
},
"session_replay_config": {
"nullable": true
},
"slack_incoming_webhook": {
"type": "string",
"nullable": true,
"maxLength": 500
},
"session_recording_opt_in": {
"type": "boolean"
},
"capture_console_log_opt_in": {
"type": "boolean",
"nullable": true
},
"capture_performance_opt_in": {
"type": "boolean",
"nullable": true
},
"effective_membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean"
},
"has_completed_onboarding_for": {
"nullable": true
},
"autocapture_exceptions_opt_in": {
"type": "boolean",
"nullable": true
},
"session_recording_linked_flag": {
"nullable": true
},
"session_recording_sample_rate": {
"type": "string",
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$",
"nullable": true
},
"person_display_name_properties": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400
},
"nullable": true
},
"groups_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"person_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"test_account_filters_default_checked": {
"type": "boolean",
"nullable": true
},
"autocapture_exceptions_errors_to_ignore": {
"nullable": true
},
"session_recording_minimum_duration_milliseconds": {
"type": "integer",
"maximum": 15000,
"minimum": 0,
"nullable": true
},
"session_recording_network_payload_capture_config": {
"nullable": true
}
}
}
TeamBasic
{
"type": "object",
"required": [
"access_control",
"api_token",
"completed_snippet_onboarding",
"has_completed_onboarding_for",
"id",
"ingested_event",
"is_demo",
"name",
"organization",
"timezone",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean",
"readOnly": true
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"access_control": {
"type": "boolean",
"readOnly": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean",
"readOnly": true
},
"has_completed_onboarding_for": {
"nullable": true,
"readOnly": true
}
},
"description": "Serializer for `Team` model with minimal attributes to speeed up loading and transfer times.\nAlso used for nested serializers.",
"x-konfig-properties": {
"timezone": {
"readOnly": true
}
}
}
ThemeModeEnum
{
"enum": [
"light",
"dark",
"system"
],
"type": "string",
"description": "* `light` - Light\n* `dark` - Dark\n* `system` - System"
}
TimeToSeeDataSessionsQuery
{
"type": "object",
"title": "TimeToSeeDataSessionsQuery",
"properties": {
"kind": {
"const": "TimeToSeeDataSessionsQuery",
"title": "Kind",
"default": "TimeToSeeDataSessionsQuery"
},
"teamId": {
"type": "integer",
"title": "Teamid",
"default": null,
"nullable": true,
"description": "Project to filter on. Defaults to current project"
},
"response": {
"$ref": "#/components/schemas/TimeToSeeDataSessionsQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
}
}
}
TimeToSeeDataSessionsQueryResponse
{
"type": "object",
"title": "TimeToSeeDataSessionsQueryResponse",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
}
}
}