InCohortVia
{
"enum": [
"auto",
"leftjoin",
"subquery",
"leftjoin_conjoined"
],
"type": "string",
"title": "InCohortVia"
}
InCohortViaNullable
{
"enum": [
"auto",
"leftjoin",
"subquery",
"leftjoin_conjoined"
],
"type": "string",
"title": "InCohortVia",
"default": null,
"nullable": true
}
Insight
{
"type": "object",
"required": [
"created_at",
"created_by",
"dashboard_tiles",
"effective_privilege_level",
"effective_restriction_level",
"id",
"is_cached",
"is_sample",
"last_modified_at",
"last_modified_by",
"last_refresh",
"next_allowed_client_refresh",
"result",
"short_id",
"timezone",
"updated_at"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"tags": {
"type": "array",
"items": {}
},
"order": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648,
"nullable": true
},
"query": {
"nullable": true,
"description": "Query node JSON string"
},
"saved": {
"type": "boolean"
},
"result": {
"type": "string",
"readOnly": true
},
"deleted": {
"type": "boolean"
},
"filters": {},
"short_id": {
"type": "string",
"readOnly": true
},
"timezone": {
"type": "string",
"readOnly": true,
"description": "The timezone this chart is displayed in."
},
"favorited": {
"type": "boolean"
},
"is_cached": {
"type": "string",
"readOnly": true
},
"is_sample": {
"type": "boolean",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"dashboards": {
"type": "array",
"items": {
"type": "integer"
},
"description": "\n DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead.\n A dashboard ID for each of the dashboards that this insight is displayed on.\n "
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"description": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"derived_name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"last_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The datetime this insight's results were generated.\n If added to one or more dashboards the insight can be refreshed separately on each.\n Returns the appropriate last_refresh datetime for the context the insight is viewed in\n (see from_dashboard query parameter).\n "
},
"dashboard_tiles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardTileBasic"
},
"readOnly": true,
"description": "\n A dashboard tile ID and dashboard_id for each of the dashboards that this insight is displayed on.\n "
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
},
"effective_privilege_level": {
"$ref": "#/components/schemas/EffectivePrivilegeLevelEnum"
},
"effective_restriction_level": {
"$ref": "#/components/schemas/EffectiveRestrictionLevelEnum"
},
"next_allowed_client_refresh": {
"type": "string",
"readOnly": true,
"description": "\n The earliest possible datetime at which we'll allow the cached results for this insight to be refreshed\n by querying the database.\n "
}
},
"description": "Simplified serializer to speed response times when loading large amounts of objects.",
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
},
"effective_privilege_level": {
"readOnly": true
},
"effective_restriction_level": {
"readOnly": true
}
}
}
InsightActorsQuery
{
"type": "object",
"title": "InsightActorsQuery",
"required": [
"source"
],
"properties": {
"day": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Day",
"default": null,
"nullable": true
},
"kind": {
"const": "InsightActorsQuery",
"title": "Kind",
"default": "InsightActorsQuery"
},
"series": {
"type": "integer",
"title": "Series",
"default": null,
"nullable": true
},
"source": {
"oneOf": [
{
"$ref": "#/components/schemas/TrendsQuery"
},
{
"$ref": "#/components/schemas/FunnelsQuery"
},
{
"$ref": "#/components/schemas/RetentionQuery"
},
{
"$ref": "#/components/schemas/PathsQuery"
},
{
"$ref": "#/components/schemas/StickinessQuery"
},
{
"$ref": "#/components/schemas/LifecycleQuery"
}
],
"title": "Source",
"discriminator": {
"mapping": {
"PathsQuery": "#/components/schemas/PathsQuery",
"TrendsQuery": "#/components/schemas/TrendsQuery",
"FunnelsQuery": "#/components/schemas/FunnelsQuery",
"LifecycleQuery": "#/components/schemas/LifecycleQuery",
"RetentionQuery": "#/components/schemas/RetentionQuery",
"StickinessQuery": "#/components/schemas/StickinessQuery"
},
"propertyName": "kind"
}
},
"status": {
"type": "string",
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"$ref": "#/components/schemas/CompareNullable"
},
"interval": {
"type": "integer",
"title": "Interval",
"default": null,
"nullable": true,
"description": "An interval selected out of available intervals in source query."
},
"response": {
"$ref": "#/components/schemas/ActorsQueryResponseNullable"
},
"breakdown": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
],
"title": "Breakdown",
"default": null,
"nullable": true
},
"includeRecordings": {
"type": "boolean",
"title": "Includerecordings",
"default": null,
"nullable": true
}
}
}
InsightActorsQueryOptions
{
"type": "object",
"title": "InsightActorsQueryOptions",
"required": [
"source"
],
"properties": {
"kind": {
"const": "InsightActorsQueryOptions",
"title": "Kind",
"default": "InsightActorsQueryOptions"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/InsightActorsQuery"
},
{
"$ref": "#/components/schemas/FunnelsActorsQuery"
},
{
"$ref": "#/components/schemas/FunnelCorrelationActorsQuery"
}
],
"title": "Source"
},
"response": {
"$ref": "#/components/schemas/InsightActorsQueryOptionsResponseNullable"
}
}
}
InsightActorsQueryOptionsResponse
{
"type": "object",
"title": "InsightActorsQueryOptionsResponse",
"properties": {
"day": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayItem"
},
"title": "Day",
"default": null,
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"title": "Series",
"default": null,
"nullable": true
},
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusItem"
},
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareItem"
},
"title": "Compare",
"default": null,
"nullable": true
},
"interval": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntervalItem"
},
"title": "Interval",
"default": null,
"nullable": true
},
"breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
},
"title": "Breakdown",
"default": null,
"nullable": true
}
}
}
InsightActorsQueryOptionsResponseNullable
{
"type": "object",
"title": "InsightActorsQueryOptionsResponse",
"default": null,
"nullable": true,
"properties": {
"day": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DayItem"
},
"title": "Day",
"default": null,
"nullable": true
},
"series": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Series"
},
"title": "Series",
"default": null,
"nullable": true
},
"status": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusItem"
},
"title": "Status",
"default": null,
"nullable": true
},
"compare": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompareItem"
},
"title": "Compare",
"default": null,
"nullable": true
},
"interval": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IntervalItem"
},
"title": "Interval",
"default": null,
"nullable": true
},
"breakdown": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BreakdownItem"
},
"title": "Breakdown",
"default": null,
"nullable": true
}
}
}
InsightVizNode
{
"type": "object",
"title": "InsightVizNode",
"required": [
"source"
],
"properties": {
"full": {
"type": "boolean",
"title": "Full",
"default": null,
"nullable": true,
"description": "Show with most visual options enabled. Used in insight scene."
},
"kind": {
"const": "InsightVizNode",
"title": "Kind",
"default": "InsightVizNode"
},
"source": {
"oneOf": [
{
"$ref": "#/components/schemas/TrendsQuery"
},
{
"$ref": "#/components/schemas/FunnelsQuery"
},
{
"$ref": "#/components/schemas/RetentionQuery"
},
{
"$ref": "#/components/schemas/PathsQuery"
},
{
"$ref": "#/components/schemas/StickinessQuery"
},
{
"$ref": "#/components/schemas/LifecycleQuery"
}
],
"title": "Source",
"discriminator": {
"mapping": {
"PathsQuery": "#/components/schemas/PathsQuery",
"TrendsQuery": "#/components/schemas/TrendsQuery",
"FunnelsQuery": "#/components/schemas/FunnelsQuery",
"LifecycleQuery": "#/components/schemas/LifecycleQuery",
"RetentionQuery": "#/components/schemas/RetentionQuery",
"StickinessQuery": "#/components/schemas/StickinessQuery"
},
"propertyName": "kind"
}
},
"embedded": {
"type": "boolean",
"title": "Embedded",
"default": null,
"nullable": true,
"description": "Query is embedded inside another bordered component"
},
"showTable": {
"type": "boolean",
"title": "Showtable",
"default": null,
"nullable": true
},
"showHeader": {
"type": "boolean",
"title": "Showheader",
"default": null,
"nullable": true
},
"showFilters": {
"type": "boolean",
"title": "Showfilters",
"default": null,
"nullable": true
},
"showResults": {
"type": "boolean",
"title": "Showresults",
"default": null,
"nullable": true
},
"hidePersonsModal": {
"type": "boolean",
"title": "Hidepersonsmodal",
"default": null,
"nullable": true
},
"vizSpecificOptions": {
"$ref": "#/components/schemas/VizSpecificOptionsNullable"
},
"showLastComputation": {
"type": "boolean",
"title": "Showlastcomputation",
"default": null,
"nullable": true
},
"showCorrelationTable": {
"type": "boolean",
"title": "Showcorrelationtable",
"default": null,
"nullable": true
},
"showLastComputationRefresh": {
"type": "boolean",
"title": "Showlastcomputationrefresh",
"default": null,
"nullable": true
},
"suppressSessionAnalysisWarning": {
"type": "boolean",
"title": "Suppresssessionanalysiswarning",
"default": null,
"nullable": true
}
}
}
InsightsGetSharingResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
IntervalEnum
{
"enum": [
"hour",
"day",
"week",
"every 5 minutes"
],
"type": "string",
"description": "* `hour` - hour\n* `day` - day\n* `week` - week\n* `every 5 minutes` - every 5 minutes"
}
IntervalItem
{
"type": "object",
"title": "IntervalItem",
"required": [
"label",
"value"
],
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"value": {
"type": "integer",
"title": "Value",
"description": "An interval selected out of available intervals in source query"
}
}
}
IntervalType
{
"enum": [
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "IntervalType"
}
IntervalTypeNullable
{
"enum": [
"hour",
"day",
"week",
"month"
],
"type": "string",
"title": "IntervalType",
"default": null,
"nullable": true,
"description": "Granularity of the response. Can be one of `hour`, `day`, `week` or `month`"
}
Key
{
"enum": [
"tag_name",
"text",
"href",
"selector"
],
"type": "string",
"title": "Key"
}
Kind
{
"enum": [
"Method",
"Function",
"Constructor",
"Field",
"Variable",
"Class",
"Struct",
"Interface",
"Module",
"Property",
"Event",
"Operator",
"Unit",
"Value",
"Constant",
"Enum",
"EnumMember",
"Keyword",
"Text",
"Color",
"File",
"Reference",
"Customcolor",
"Folder",
"TypeParameter",
"User",
"Issue",
"Snippet"
],
"type": "string",
"title": "Kind"
}
Kind1
{
"enum": [
"ActionsNode",
"EventsNode"
],
"type": "string",
"title": "Kind1"
}
Kind1Nullable
{
"enum": [
"ActionsNode",
"EventsNode"
],
"type": "string",
"title": "Kind1",
"default": null,
"nullable": true
}
Kind2
{
"enum": [
"unit",
"duration_s",
"percentage"
],
"type": "string",
"title": "Kind2"
}
LevelD7eEnum
{
"enum": [
21,
37
],
"type": "integer",
"description": "* `21` - Everyone in the project can edit\n* `37` - Only those invited to this dashboard can edit"
}
LifecycleFilter
{
"type": "object",
"title": "LifecycleFilter",
"properties": {
"toggledLifecycles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifecycleToggle"
},
"title": "Toggledlifecycles",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
}
}
}
LifecycleFilterNullable
{
"type": "object",
"title": "LifecycleFilter",
"default": null,
"nullable": true,
"properties": {
"toggledLifecycles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LifecycleToggle"
},
"title": "Toggledlifecycles",
"default": null,
"nullable": true
},
"showValuesOnSeries": {
"type": "boolean",
"title": "Showvaluesonseries",
"default": null,
"nullable": true
}
},
"description": "Properties specific to the lifecycle insight"
}
LifecycleQuery
{
"type": "object",
"title": "LifecycleQuery",
"required": [
"series"
],
"properties": {
"kind": {
"const": "LifecycleQuery",
"title": "Kind",
"default": "LifecycleQuery"
},
"series": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventsNode"
},
{
"$ref": "#/components/schemas/ActionsNode"
},
{
"$ref": "#/components/schemas/DataWarehouseNode"
}
]
},
"title": "Series",
"description": "Events and actions to include"
},
"interval": {
"$ref": "#/components/schemas/IntervalTypeNullable"
},
"response": {
"$ref": "#/components/schemas/LifecycleQueryResponseNullable"
},
"dateRange": {
"$ref": "#/components/schemas/DateRangeNullable"
},
"properties": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingDurationFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
}
]
}
},
{
"$ref": "#/components/schemas/PropertyGroupFilter"
}
],
"title": "Properties",
"default": null,
"nullable": true,
"description": "Property filters for all series"
},
"samplingFactor": {
"type": "number",
"title": "Samplingfactor",
"default": null,
"nullable": true,
"description": "Sampling rate"
},
"lifecycleFilter": {
"$ref": "#/components/schemas/LifecycleFilterNullable"
},
"filterTestAccounts": {
"type": "boolean",
"title": "Filtertestaccounts",
"default": null,
"nullable": true,
"description": "Exclude internal and test users by applying the respective filters"
}
}
}
LifecycleQueryResponse
{
"type": "object",
"title": "LifecycleQueryResponse",
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
LifecycleQueryResponseNullable
{
"type": "object",
"title": "LifecycleQueryResponse",
"default": null,
"nullable": true,
"required": [
"results"
],
"properties": {
"hogql": {
"type": "string",
"title": "Hogql",
"default": null,
"nullable": true
},
"results": {
"type": "array",
"items": {
"type": "object"
},
"title": "Results"
},
"timings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueryTiming"
},
"title": "Timings",
"default": null,
"nullable": true
},
"is_cached": {
"type": "boolean",
"title": "Is Cached",
"default": null,
"nullable": true
},
"last_refresh": {
"type": "string",
"title": "Last Refresh",
"default": null,
"nullable": true
},
"next_allowed_client_refresh": {
"type": "string",
"title": "Next Allowed Client Refresh",
"default": null,
"nullable": true
}
}
}
LifecycleToggle
{
"enum": [
"new",
"resurrecting",
"returning",
"dormant"
],
"type": "string",
"title": "LifecycleToggle"
}
MaterializationMode
{
"enum": [
"auto",
"legacy_null_as_string",
"legacy_null_as_null",
"disabled"
],
"type": "string",
"title": "MaterializationMode"
}
MaterializationModeNullable
{
"enum": [
"auto",
"legacy_null_as_string",
"legacy_null_as_null",
"disabled"
],
"type": "string",
"title": "MaterializationMode",
"default": null,
"nullable": true
}
MathEnum
{
"enum": [
"total",
"dau",
"weekly_active",
"monthly_active",
"unique_group",
"unique_session",
"sum",
"min",
"max",
"avg",
"median",
"p90",
"p95",
"p99",
"min_count_per_actor",
"max_count_per_actor",
"avg_count_per_actor",
"median_count_per_actor",
"p90_count_per_actor",
"p95_count_per_actor",
"p99_count_per_actor",
"hogql"
],
"type": "string",
"description": "* `total` - total\n* `dau` - dau\n* `weekly_active` - weekly_active\n* `monthly_active` - monthly_active\n* `unique_group` - unique_group\n* `unique_session` - unique_session\n* `sum` - sum\n* `min` - min\n* `max` - max\n* `avg` - avg\n* `median` - median\n* `p90` - p90\n* `p95` - p95\n* `p99` - p99\n* `min_count_per_actor` - min_count_per_actor\n* `max_count_per_actor` - max_count_per_actor\n* `avg_count_per_actor` - avg_count_per_actor\n* `median_count_per_actor` - median_count_per_actor\n* `p90_count_per_actor` - p90_count_per_actor\n* `p95_count_per_actor` - p95_count_per_actor\n* `p99_count_per_actor` - p99_count_per_actor\n* `hogql` - hogql"
}
MathGroupTypeIndex
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"title": "MathGroupTypeIndex"
}
MathGroupTypeIndexNullable
{
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"title": "MathGroupTypeIndex",
"default": null,
"nullable": true
}
MinimalFeatureFlag
{
"type": "object",
"required": [
"id",
"key",
"team_id"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"key": {
"type": "string",
"maxLength": 400
},
"name": {
"type": "string"
},
"active": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"filters": {
"type": "object",
"additionalProperties": {}
},
"team_id": {
"type": "integer",
"readOnly": true
},
"ensure_experience_continuity": {
"type": "boolean",
"nullable": true
}
}
}
MinimalPerson
{
"type": "object",
"required": [
"created_at",
"distinct_ids",
"id",
"name",
"uuid"
],
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"readOnly": true
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"properties": {},
"distinct_ids": {
"type": "string",
"readOnly": true
}
}
}
Notebook
{
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"last_modified_at",
"last_modified_by",
"short_id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"maxLength": 256
},
"content": {
"nullable": true
},
"deleted": {
"type": "boolean"
},
"version": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"text_content": {
"type": "string",
"nullable": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
NotebookMinimal
{
"type": "object",
"required": [
"created_at",
"created_by",
"deleted",
"id",
"last_modified_at",
"last_modified_by",
"short_id",
"title"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"title": {
"type": "string",
"nullable": true,
"readOnly": true
},
"deleted": {
"type": "boolean",
"readOnly": true
},
"short_id": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"last_modified_by": {
"$ref": "#/components/schemas/UserBasic"
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
},
"last_modified_by": {
"readOnly": true
}
}
}
NullEnum
{
"enum": [
null
],
"type": "object"
}
OperatorEnum
{
"enum": [
"exact",
"is_not",
"icontains",
"not_icontains",
"regex",
"not_regex",
"gt",
"lt",
"gte",
"lte",
"is_set",
"is_not_set",
"is_date_exact",
"is_date_after",
"is_date_before"
],
"type": "string",
"description": "* `exact` - exact\n* `is_not` - is_not\n* `icontains` - icontains\n* `not_icontains` - not_icontains\n* `regex` - regex\n* `not_regex` - not_regex\n* `gt` - gt\n* `lt` - lt\n* `gte` - gte\n* `lte` - lte\n* `is_set` - is_set\n* `is_not_set` - is_not_set\n* `is_date_exact` - is_date_exact\n* `is_date_after` - is_date_after\n* `is_date_before` - is_date_before"
}
Organization
{
"type": "object",
"required": [
"available_features",
"available_product_features",
"created_at",
"customer_id",
"id",
"member_count",
"membership_level",
"metadata",
"name",
"plugins_access_level",
"slug",
"teams",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"readOnly": true
},
"teams": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"readOnly": true
},
"metadata": {
"type": "string",
"readOnly": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customer_id": {
"type": "string",
"nullable": true,
"readOnly": true
},
"enforce_2fa": {
"type": "boolean",
"nullable": true
},
"member_count": {
"type": "string",
"readOnly": true
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
},
"available_features": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"readOnly": true
},
"plugins_access_level": {
"$ref": "#/components/schemas/PluginsAccessLevelEnum"
},
"available_product_features": {
"type": "array",
"items": {},
"nullable": true,
"readOnly": true
},
"is_member_join_email_enabled": {
"type": "boolean"
}
},
"x-konfig-properties": {
"plugins_access_level": {
"readOnly": true
}
}
}
OrganizationBasic
{
"type": "object",
"required": [
"id",
"membership_level",
"name",
"slug"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 64
},
"slug": {
"type": "string",
"pattern": "^[-a-zA-Z0-9_]+$",
"maxLength": 48
},
"membership_level": {
"allOf": [
{
"$ref": "#/components/schemas/EffectiveMembershipLevelEnum"
}
],
"nullable": true,
"readOnly": true
}
},
"description": "Serializer for `Organization` model with minimal attributes to speeed up loading and transfer times.\nAlso used for nested serializers."
}
OrganizationDomain
{
"type": "object",
"required": [
"domain",
"has_saml",
"id",
"is_verified",
"verification_challenge",
"verified_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"domain": {
"type": "string",
"maxLength": 128
},
"has_saml": {
"type": "boolean",
"readOnly": true,
"description": "Returns whether SAML is configured for the instance. Does not validate the user has the required license (that check is performed in other places)."
},
"is_verified": {
"type": "boolean",
"readOnly": true,
"description": "Determines whether a domain is verified or not."
},
"verified_at": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
},
"saml_acs_url": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_entity_id": {
"type": "string",
"nullable": true,
"maxLength": 512
},
"saml_x509_cert": {
"type": "string",
"nullable": true
},
"sso_enforcement": {
"type": "string",
"maxLength": 28
},
"verification_challenge": {
"type": "string",
"readOnly": true
},
"jit_provisioning_enabled": {
"type": "boolean"
}
}
}
OrganizationInvite
{
"type": "object",
"required": [
"created_at",
"created_by",
"emailing_attempt_made",
"id",
"is_expired",
"target_email",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"message": {
"type": "string",
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"$ref": "#/components/schemas/UserBasic"
},
"first_name": {
"type": "string",
"maxLength": 30
},
"is_expired": {
"type": "boolean",
"readOnly": true,
"description": "Check if invite is older than INVITE_DAYS_VALIDITY days."
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"target_email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"emailing_attempt_made": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"created_by": {
"readOnly": true
}
}
}
OrganizationMember
{
"type": "object",
"required": [
"has_social_auth",
"id",
"is_2fa_enabled",
"joined_at",
"updated_at",
"user"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"level": {
"$ref": "#/components/schemas/OrganizationMemberLevelEnum"
},
"joined_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"is_2fa_enabled": {
"type": "boolean",
"readOnly": true
},
"has_social_auth": {
"type": "boolean",
"readOnly": true
}
},
"x-konfig-properties": {
"user": {
"readOnly": true
},
"level": {
"maximum": 32767,
"minimum": 0
}
}
}
OrganizationMemberLevelEnum
{
"enum": [
1,
8,
15
],
"type": "integer",
"description": "* `1` - member\n* `8` - administrator\n* `15` - owner"
}
PaginatedActionList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Action"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedActivityLogList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityLog"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedAnnotationList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Annotation"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExport"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportLogEntryList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExportLogEntry"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}
PaginatedBatchExportRunList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"previous": {
"type": "string",
"nullable": true
}
}
}
PaginatedClickhouseEventList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
}
}
}
PaginatedCohortList
{
"type": "object",
"properties": {
"next": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"nullable": true
},
"count": {
"type": "integer",
"example": 123
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Cohort"
}
},
"previous": {
"type": "string",
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"nullable": true
}
}
}