PaginatedDashboardBasicList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardBasic"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedDashboardTemplateList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedEarlyAccessFeatureList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedExperimentList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Experiment"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedExportedAssetList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedFeatureFlagList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedFeatureFlagRoleAccessList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedGroupList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Group"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedInsightList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Insight"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedNotebookMinimalList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotebookMinimal"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationDomainList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationInviteList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Organization"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedOrganizationMemberList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPersonList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 400
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100",
"nullable": true
}
}
}
PaginatedPluginConfigList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginConfig"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPluginList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plugin"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedPluginLogEntryList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PluginLogEntry"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedRoleList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Role"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedRoleMembershipList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleMembership"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSessionRecordingList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSessionRecordingPlaylistList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSubscriptionList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Subscription"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedSurveyList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Survey"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedTeamBasicList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamBasic"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedUserList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PatchedAction
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionStep"
}
},
"deleted": {
"type": "boolean"
},
"team_id": {
"type": "integer",
"readOnly": true
},
"is_action": {
"type": "boolean",
"default": true,
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"post_to_slack": {
"type": "boolean"
},
"bytecode_error": {
"type": "string",
"nullable": true,
"readOnly": true
},
"is_calculating": {
"type": "boolean",
"readOnly": true
},
"last_calculated_at": {
"type": "string",
"format": "date-time"
},
"slack_message_format": {
"type": "string",
"maxLength": 600
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedAnnotation
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"scope": {
"$ref": "#/components/schemas/AnnotationScopeEnum"
},
"content": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"deleted": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_marker": {
"type": "string",
"format": "date-time",
"nullable": true
},
"insight_name": {
"type": "string",
"nullable": true,
"readOnly": true
},
"creation_type": {
"$ref": "#/components/schemas/CreationTypeEnum"
},
"dashboard_item": {
"type": "integer",
"nullable": true
},
"insight_short_id": {
"type": "string",
"nullable": true,
"readOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedBatchExport
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"description": "A human-readable name for this BatchExport."
},
"end_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Time after which any Batch Export runs won't be triggered."
},
"paused": {
"type": "boolean",
"description": "Whether this BatchExport is paused or not."
},
"schema": {
"nullable": true,
"readOnly": true,
"description": "A schema of custom fields to select when exporting data."
},
"team_id": {
"type": "integer",
"readOnly": true,
"description": "The team this belongs to."
},
"interval": {
"$ref": "#/components/schemas/IntervalEnum"
},
"start_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Time before which any Batch Export runs won't be triggered."
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The timestamp at which this BatchExport was created."
},
"destination": {
"$ref": "#/components/schemas/BatchExportDestination"
},
"hogql_query": {
"type": "string"
},
"latest_runs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExportRun"
},
"readOnly": true
},
"last_paused_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "The timestamp at which this BatchExport was last paused."
},
"last_updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The timestamp at which this BatchExport was last updated."
}
},
"description": "Serializer for a BatchExport model."
}
PatchedCohort
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"count": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"query": {
"nullable": true
},
"groups": {},
"deleted": {
"type": "boolean"
},
"filters": {
"nullable": true
},
"is_static": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string",
"maxLength": 1000
},
"is_calculating": {
"type": "boolean",
"readOnly": true
},
"last_calculation": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"errors_calculating": {
"type": "integer",
"readOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedDashboard
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"tiles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true,
"readOnly": true
},
"pinned": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {},
"is_shared": {
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"use_template": {
"type": "string",
"writeOnly": true
},
"creation_mode": {
"$ref": "#/components/schemas/CreationModeEnum"
},
"use_dashboard": {
"type": "integer",
"nullable": true,
"writeOnly": true
},
"delete_insights": {
"type": "boolean",
"default": false,
"writeOnly": true
},
"restriction_level": {
"$ref": "#/components/schemas/RestrictionLevelEnum"
},
"effective_privilege_level": {
"$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
},
"effective_restriction_level": {
"$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"creation_mode": {
"readOnly": true
},
"restriction_level": {
"maximum": 32767,
"minimum": 0
},
"effective_privilege_level": {
"readOnly": true
},
"effective_restriction_level": {
"readOnly": true
}
}
}
PatchedDashboardTemplate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255
},
"nullable": true
},
"scope": {
"oneOf": [
{
"$ref": "#/components/schemas/DashboardTemplateScopeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"tiles": {
"nullable": true
},
"deleted": {
"type": "boolean",
"nullable": true
},
"team_id": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"image_url": {
"type": "string",
"nullable": true,
"maxLength": 8201
},
"variables": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"type": "integer",
"nullable": true
},
"template_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"dashboard_filters": {
"nullable": true
},
"dashboard_description": {
"type": "string",
"nullable": true,
"maxLength": 400
}
}
}
PatchedEarlyAccessFeature
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"stage": {
"$ref": "#/components/schemas/StageEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string"
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"documentation_url": {
"type": "string",
"format": "uri",
"maxLength": 800
}
},
"x-konfig-properties": {
"feature_flag": {
"readOnly": true
}
}
}
PatchedExperiment
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"filters": {},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"parameters": {
"nullable": true
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"feature_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"feature_flag_key": {
"type": "string"
},
"secondary_metrics": {
"nullable": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flag": {
"readOnly": true
}
}
}
PatchedExplicitTeamMember
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/ExplicitTeamMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"user_uuid": {
"type": "string",
"format": "uuid",
"writeOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"parent_level": {
"type": "integer",
"readOnly": true
},
"effective_level": {
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
},
"parent_membership_id": {
"type": "string",
"format": "uuid",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
},
"effective_level": {
"readOnly": true,
"description": "If organization level is higher than project level, then that takes precedence over explicit project level."
}
}
}
PatchedFeatureFlag
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string",
"description": "contains the description for the flag (field name `name` is kept for backwards-compatibility)"
},
"tags": {
"type": "array",
"items": {}
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"surveys": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"can_edit": {
"type": "boolean",
"readOnly": true
},
"features": {
"type": "object",
"readOnly": true,
"additionalProperties": {}
},
"created_at": {
"type": "string",
"format": "date-time"
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"experiment_set": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true
},
"is_simple_flag": {
"type": "boolean",
"readOnly": true
},
"usage_dashboard": {
"type": "integer",
"readOnly": true
},
"performed_rollback": {
"type": "boolean",
"nullable": true
},
"rollout_percentage": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"rollback_conditions": {
"nullable": true
},
"analytics_dashboards": {
"type": "array",
"items": {
"type": "integer"
}
},
"has_enriched_analytics": {
"type": "boolean",
"nullable": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
},
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedGroupType
{
"type": "object",
"properties": {
"group_type": {
"type": "string",
"readOnly": true
},
"name_plural": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"name_singular": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"group_type_index": {
"type": "integer",
"readOnly": true
}
}
}
PatchedInsight
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"query": {
"nullable": true,
"description": "Query node JSON string"
},
"saved": {
"type": "boolean"
},
"result": {
"type": "string",
"readOnly": true
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"timezone": {
"type": "string",
"readOnly": true,
"description": "The timezone this chart is displayed in."
},
"favorited": {
"type": "boolean"
},
"is_cached": {
"type": "string",
"readOnly": true
},
"is_sample": {
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"dashboards": {
"type": "array",
"items": {
"type": "integer"
},
"description": "\n DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.\n A dashboard ID for each of the dashboards that this insight is displayed on.\n "
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The datetime this insight's results were generated.\n If added to one or more dashboards the insight can be refreshed separately on each.\n Returns the appropriate last_refresh datetime for the context the insight is viewed in\n (see from_dashboard query parameter).\n "
},
"dashboard_tiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTileBasic"
},
"readOnly": true,
"description": "\n A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.\n "
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
},
"effective_privilege_level": {
"$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
},
"effective_restriction_level": {
"$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
},
"next_allowed_client_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed\n by querying the database.\n "
}
},
"description": "Simplified serializer to speed response times when loading large amounts of objects.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
},
"effective_privilege_level": {
"readOnly": true
},
"effective_restriction_level": {
"readOnly": true
}
}
}
PatchedNotebook
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 256
},
"content": {
"nullable": true
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"text_content": {
"type": "string",
"nullable": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
PatchedOrganization
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true
},
"teams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"readOnly": true
},
"metadata": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customer_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enforce_2fa": {
"type": "boolean",
"nullable": true
},
"member_count": {
"type": "string",
"readOnly": true
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"available_features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"readOnly": true
},
"plugins_access_level": {
"$ref": "#/components/schemas/PluginsAccessLevelEnum"
},
"available_product_features": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"is_member_join_email_enabled": {
"type": "boolean"
}
},
"x-konfig-properties": {
"plugins_access_level": {
"readOnly": true
}
}
}
PatchedOrganizationDomain
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"domain": {
"type": "string",
"maxLength": 128
},
"has_saml": {
"type": "boolean",
"readOnly": true,
"description": "Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places)."
},
"is_verified": {
"type": "boolean",
"readOnly": true,
"description": "Determines whether a domain is verified or not."
},
"verified_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"saml_acs_url": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_entity_id": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_x509_cert": {
"type": "string",
"nullable": true
},
"sso_enforcement": {
"type": "string",
"maxLength": 28
},
"verification_challenge": {
"type": "string",
"readOnly": true
},
"jit_provisioning_enabled": {
"type": "boolean"
}
}
}
PatchedOrganizationMember
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/OrganizationMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
}
}
}
PatchedPerson
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
}
}
}
PatchedPlugin
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"tag": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"url": {
"type": "string",
"nullable": true,
"readOnly": true
},
"icon": {
"type": "string",
"nullable": true,
"maxLength": 800
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"metrics": {
"nullable": true
},
"is_global": {
"type": "boolean"
},
"latest_tag": {
"type": "string",
"nullable": true,
"readOnly": true
},
"description": {
"type": "string",
"nullable": true
},
"plugin_type": {
"oneOf": [
{
"$ref": "#/components/schemas/PluginTypeEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"nullable": true
},
"public_jobs": {
"nullable": true
},
"capabilities": {},
"config_schema": {},
"organization_id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"organization_name": {
"type": "string",
"readOnly": true
}
}
}
PatchedPluginConfig
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"error": {
"type": "string",
"readOnly": true
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"config": {
"type": "string",
"readOnly": true
},
"plugin": {
"type": "integer"
},
"deleted": {
"type": "boolean",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"team_id": {
"type": "integer",
"nullable": true,
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 1000
},
"plugin_info": {
"type": "string",
"readOnly": true
},
"delivery_rate_24h": {
"type": "string",
"readOnly": true
}
}
}
PatchedRole
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200
},
"members": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"associated_flags": {
"type": "string",
"readOnly": true
},
"feature_flags_access_level": {
"$ref": "#/components/schemas/FeatureFlagsAccessLevelEnum"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"feature_flags_access_level": {
"maximum": 32767,
"minimum": 0
}
}
}
PatchedSessionRecordingPlaylist
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"pinned": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"description": {
"type": "string"
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
PatchedSubscription
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 100
},
"deleted": {
"type": "boolean"
},
"insight": {
"type": "integer",
"nullable": true
},
"summary": {
"type": "string",
"readOnly": true
},
"bysetpos": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"interval": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"byweekday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ByweekdayEnum"
},
"nullable": true
},
"dashboard": {
"type": "integer",
"nullable": true
},
"frequency": {
"$ref": "#/components/schemas/FrequencyEnum"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time"
},
"until_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"target_type": {
"$ref": "#/components/schemas/TargetTypeEnum"
},
"target_value": {
"type": "string"
},
"invite_message": {
"type": "string",
"nullable": true
},
"next_delivery_date": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
}
},
"description": "Standard Subscription serializer.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
PatchedSurveySerializerCreateUpdateOnly
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 400
},
"type": {
"$ref": "#/components/schemas/Type7baEnum"
},
"archived": {
"type": "boolean"
},
"end_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"questions": {
"nullable": true
},
"appearance": {
"nullable": true
},
"conditions": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"start_date": {
"type": "string",
"format": "date-time",
"nullable": true
},
"description": {
"type": "string"
},
"linked_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"linked_flag_id": {
"type": "integer",
"nullable": true,
"writeOnly": true
},
"targeting_flag": {
"$ref": "#/components/schemas/MinimalFeatureFlag"
},
"targeting_flag_id": {
"type": "integer",
"writeOnly": true
},
"remove_targeting_flag": {
"type": "boolean",
"nullable": true,
"writeOnly": true
},
"targeting_flag_filters": {
"nullable": true,
"writeOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"linked_flag": {
"readOnly": true
},
"targeting_flag": {
"readOnly": true
}
}
}
PatchedTeam
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"is_demo": {
"type": "boolean"
},
"app_urls": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
}
},
"timezone": {
"$ref": "#/components/schemas/TimezoneEnum"
},
"api_token": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"organization": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"anonymize_ips": {
"type": "boolean"
},
"access_control": {
"type": "boolean"
},
"extra_settings": {
"nullable": true
},
"ingested_event": {
"type": "boolean",
"readOnly": true
},
"surveys_opt_in": {
"type": "boolean",
"nullable": true
},
"week_start_day": {
"oneOf": [
{
"$ref": "#/components/schemas/WeekStartDayEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"maximum": 32767,
"minimum": -32768,
"nullable": true
},
"data_attributes": {},
"has_group_types": {
"type": "boolean",
"readOnly": true
},
"inject_web_apps": {
"type": "boolean",
"nullable": true
},
"primary_dashboard": {
"type": "integer",
"nullable": true
},
"recording_domains": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"maxLength": 200
},
"nullable": true
},
"correlation_config": {
"nullable": true
},
"autocapture_opt_out": {
"type": "boolean",
"nullable": true
},
"live_events_columns": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"test_account_filters": {},
"path_cleaning_filters": {
"nullable": true
},
"session_replay_config": {
"nullable": true
},
"slack_incoming_webhook": {
"type": "string",
"nullable": true,
"maxLength": 500
},
"session_recording_opt_in": {
"type": "boolean"
},
"capture_console_log_opt_in": {
"type": "boolean",
"nullable": true
},
"capture_performance_opt_in": {
"type": "boolean",
"nullable": true
},
"effective_membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"completed_snippet_onboarding": {
"type": "boolean"
},
"has_completed_onboarding_for": {
"nullable": true
},
"autocapture_exceptions_opt_in": {
"type": "boolean",
"nullable": true
},
"session_recording_linked_flag": {
"nullable": true
},
"session_recording_sample_rate": {
"type": "string",
"format": "decimal",
"pattern": "^-?\\d{0,1}(?:\\.\\d{0,2})?$",
"nullable": true
},
"person_display_name_properties": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400
},
"nullable": true
},
"groups_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"person_on_events_querying_enabled": {
"type": "boolean",
"readOnly": true
},
"test_account_filters_default_checked": {
"type": "boolean",
"nullable": true
},
"autocapture_exceptions_errors_to_ignore": {
"nullable": true
},
"session_recording_minimum_duration_milliseconds": {
"type": "integer",
"maximum": 15000,
"minimum": 0,
"nullable": true
},
"session_recording_network_payload_capture_config": {
"nullable": true
}
}
}