Skip to content

Instantly share code, notes, and snippets.

@jaycmpb

jaycmpb/PostHog OpenAPI JSON.json

Created June 8, 2025 14:12
Show Gist options
  • Save jaycmpb/7ffff5a32f56a64c4567a4de4e19a8b2 to your computer and use it in GitHub Desktop.
Save jaycmpb/7ffff5a32f56a64c4567a4de4e19a8b2 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
PostHog OpenAPI JSON.json
This file has been truncated, but you can view the full file.
{
"openapi": "3.0.3",
"info": {
"title": "PostHog API",
"version": null,
"description": ""
},
"paths": {
"/api/environments/{project_id}/app_metrics/{id}/": {
"get": {
"operationId": "environments_app_metrics_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this plugin config.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/app_metrics/{id}/error_details/": {
"get": {
"operationId": "environments_app_metrics_error_details_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this plugin config.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/app_metrics/{plugin_config_id}/historical_exports/": {
"get": {
"operationId": "environments_app_metrics_historical_exports_retrieve",
"parameters": [
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/app_metrics/{plugin_config_id}/historical_exports/{id}/": {
"get": {
"operationId": "environments_app_metrics_historical_exports_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/": {
"get": {
"operationId": "environments_batch_exports_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_batch_exports_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/backfills/": {
"get": {
"operationId": "environments_batch_exports_backfills_list",
"description": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportBackfillList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_batch_exports_backfills_create",
"description": "Create a new backfill for a BatchExport.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/": {
"get": {
"operationId": "environments_batch_exports_backfills_retrieve",
"description": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export backfill.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/": {
"post": {
"operationId": "environments_batch_exports_backfills_cancel_create",
"description": "Cancel a batch export backfill.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export backfill.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/runs/": {
"get": {
"operationId": "environments_batch_exports_runs_list",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportRunList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/runs/{id}/": {
"get": {
"operationId": "environments_batch_exports_runs_retrieve",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/": {
"post": {
"operationId": "environments_batch_exports_runs_cancel_create",
"description": "Cancel a batch export run.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/runs/{id}/logs/": {
"get": {
"operationId": "environments_batch_exports_runs_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{batch_export_id}/runs/{id}/retry/": {
"post": {
"operationId": "environments_batch_exports_runs_retry_create",
"description": "Retry a batch export run.\n\nWe use the same underlying mechanism as when backfilling a batch export, as retrying\na run is the same as backfilling one run.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/": {
"get": {
"operationId": "environments_batch_exports_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_batch_exports_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_batch_exports_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_batch_exports_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/backfill/": {
"post": {
"operationId": "environments_batch_exports_backfill_create",
"description": "Trigger a backfill for a BatchExport.\n\nNote: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/logs/": {
"get": {
"operationId": "environments_batch_exports_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/pause/": {
"post": {
"operationId": "environments_batch_exports_pause_create",
"description": "Pause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/run_test_step/": {
"post": {
"operationId": "environments_batch_exports_run_test_step_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/{id}/unpause/": {
"post": {
"operationId": "environments_batch_exports_unpause_create",
"description": "Unpause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/run_test_step_new/": {
"post": {
"operationId": "environments_batch_exports_run_test_step_new_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/batch_exports/test/": {
"get": {
"operationId": "environments_batch_exports_test_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/dashboards/": {
"get": {
"operationId": "environments_dashboards_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDashboardBasicList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_dashboards_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/dashboards/{dashboard_id}/collaborators/": {
"get": {
"operationId": "environments_dashboards_collaborators_list",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_dashboards_collaborators_create",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/": {
"delete": {
"operationId": "environments_dashboards_collaborators_destroy",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/dashboards/{dashboard_id}/sharing/": {
"get": {
"operationId": "environments_dashboards_sharing_list",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/dashboards/{id}/": {
"get": {
"operationId": "environments_dashboards_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_dashboards_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_dashboards_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_dashboards_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/dashboards/{id}/move_tile/": {
"patch": {
"operationId": "environments_dashboards_move_tile_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/dashboards/create_from_template_json/": {
"post": {
"operationId": "environments_dashboards_create_from_template_json_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/error_tracking/assignment_rules/": {
"get": {
"operationId": "environments_error_tracking_assignment_rules_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedErrorTrackingAssignmentRuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_error_tracking_assignment_rules_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/error_tracking/assignment_rules/{id}/": {
"get": {
"operationId": "environments_error_tracking_assignment_rules_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking assignment rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_error_tracking_assignment_rules_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking assignment rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_error_tracking_assignment_rules_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking assignment rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingAssignmentRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingAssignmentRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingAssignmentRule"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingAssignmentRule"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_error_tracking_assignment_rules_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking assignment rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/error_tracking/grouping_rules/": {
"get": {
"operationId": "environments_error_tracking_grouping_rules_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedErrorTrackingGroupingRuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_error_tracking_grouping_rules_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/error_tracking/grouping_rules/{id}/": {
"get": {
"operationId": "environments_error_tracking_grouping_rules_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking grouping rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_error_tracking_grouping_rules_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking grouping rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_error_tracking_grouping_rules_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking grouping rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingGroupingRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingGroupingRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingGroupingRule"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingGroupingRule"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_error_tracking_grouping_rules_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking grouping rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/error_tracking/releases/": {
"get": {
"operationId": "environments_error_tracking_releases_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedErrorTrackingReleaseList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_error_tracking_releases_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/error_tracking/releases/{id}/": {
"get": {
"operationId": "environments_error_tracking_releases_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking release.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_error_tracking_releases_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking release.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_error_tracking_releases_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking release.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingRelease"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingRelease"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingRelease"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingRelease"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_error_tracking_releases_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking release.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/error_tracking/suppression_rules/": {
"get": {
"operationId": "environments_error_tracking_suppression_rules_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedErrorTrackingSuppressionRuleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_error_tracking_suppression_rules_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/error_tracking/suppression_rules/{id}/": {
"get": {
"operationId": "environments_error_tracking_suppression_rules_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking suppression rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_error_tracking_suppression_rules_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking suppression rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_error_tracking_suppression_rules_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking suppression rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingSuppressionRule"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingSuppressionRule"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingSuppressionRule"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSuppressionRule"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_error_tracking_suppression_rules_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking suppression rule.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/error_tracking/symbol_sets/": {
"get": {
"operationId": "environments_error_tracking_symbol_sets_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedErrorTrackingSymbolSetList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_error_tracking_symbol_sets_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
},
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/error_tracking/symbol_sets/{id}/": {
"get": {
"operationId": "environments_error_tracking_symbol_sets_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking symbol set.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_error_tracking_symbol_sets_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking symbol set.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
},
"*/*": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_error_tracking_symbol_sets_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking symbol set.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingSymbolSet"
}
},
"*/*": {
"schema": {
"$ref": "#/components/schemas/PatchedErrorTrackingSymbolSet"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorTrackingSymbolSet"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_error_tracking_symbol_sets_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this error tracking symbol set.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/events/": {
"get": {
"operationId": "environments_events_list",
"description": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n ",
"parameters": [
{
"in": "query",
"name": "after",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Only return events with a timestamp after this time."
},
{
"in": "query",
"name": "before",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Only return events with a timestamp before this time."
},
{
"in": "query",
"name": "distinct_id",
"schema": {
"type": "integer"
},
"description": "Filter list by distinct id."
},
{
"in": "query",
"name": "event",
"schema": {
"type": "string"
},
"description": "Filter list by event. For example `user sign up` or `$pageview`."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer"
},
"description": "The maximum number of results to return"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "person_id",
"schema": {
"type": "integer"
},
"description": "Filter list by person id."
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
},
"description": "Filter events by event property, person property, cohort, groups and more."
},
{
"in": "query",
"name": "select",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "(Experimental) JSON-serialized array of HogQL expressions to return"
},
{
"in": "query",
"name": "where",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "(Experimental) JSON-serialized array of HogQL expressions that must pass"
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedClickhouseEventList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedClickhouseEventList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/events/{id}/": {
"get": {
"operationId": "environments_events_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/events/values/": {
"get": {
"operationId": "environments_events_values_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/explicit_members/": {
"get": {
"operationId": "environments_explicit_members_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_explicit_members_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/explicit_members/{parent_membership__user__uuid}/": {
"get": {
"operationId": "environments_explicit_members_retrieve",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_explicit_members_update",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_explicit_members_partial_update",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_explicit_members_destroy",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/exports/": {
"get": {
"operationId": "environments_exports_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExportedAssetList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_exports_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/exports/{id}/": {
"get": {
"operationId": "environments_exports_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this exported asset.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/exports/{id}/content/": {
"get": {
"operationId": "environments_exports_content_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this exported asset.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/": {
"get": {
"operationId": "environments_groups_list",
"description": "List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/",
"parameters": [
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to list",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Search the group name",
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedGroupList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/groups/activity/": {
"get": {
"operationId": "environments_groups_activity_retrieve",
"parameters": [
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"description": "Specify the id of the user to find groups for",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/delete_property/": {
"post": {
"operationId": "environments_groups_delete_property_create",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"group:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/find/": {
"get": {
"operationId": "environments_groups_find_retrieve",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/property_definitions/": {
"get": {
"operationId": "environments_groups_property_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/property_values/": {
"get": {
"operationId": "environments_groups_property_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/related/": {
"get": {
"operationId": "environments_groups_related_retrieve",
"parameters": [
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"description": "Specify the id of the user to find groups for",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/groups/update_property/": {
"post": {
"operationId": "environments_groups_update_property_create",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"group:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/": {
"get": {
"operationId": "environments_hog_functions_list",
"parameters": [
{
"in": "query",
"name": "created_at",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "exclude_kind",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "kind",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "updated_at",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedHogFunctionMinimalList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_hog_functions_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/": {
"get": {
"operationId": "environments_hog_functions_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_hog_functions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_hog_functions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_hog_functions_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/broadcast/": {
"post": {
"operationId": "environments_hog_functions_broadcast_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/invocations/": {
"post": {
"operationId": "environments_hog_functions_invocations_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/logs/": {
"get": {
"operationId": "environments_hog_functions_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/metrics/": {
"get": {
"operationId": "environments_hog_functions_metrics_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/{id}/metrics/totals/": {
"get": {
"operationId": "environments_hog_functions_metrics_totals_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/icon/": {
"get": {
"operationId": "environments_hog_functions_icon_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/icons/": {
"get": {
"operationId": "environments_hog_functions_icons_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/hog_functions/rearrange/": {
"patch": {
"operationId": "environments_hog_functions_rearrange_partial_update",
"description": "Update the execution order of multiple HogFunctions.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/": {
"get": {
"operationId": "environments_insights_list",
"parameters": [
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "refresh",
"schema": {
"type": "string",
"enum": [
"async",
"async_except_on_cache_miss",
"blocking",
"force_async",
"force_blocking",
"force_cache",
"lazy_async"
],
"default": "force_cache"
},
"description": "\nWhether to refresh the retrieved insights, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field."
},
{
"in": "query",
"name": "short_id",
"schema": {
"type": "string"
}
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInsightList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedInsightList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_insights_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/insights/{insight_id}/sharing/": {
"get": {
"operationId": "environments_insights_sharing_list",
"parameters": [
{
"in": "path",
"name": "insight_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/insights/{id}/": {
"get": {
"operationId": "environments_insights_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "from_dashboard",
"schema": {
"type": "integer"
},
"description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "refresh",
"schema": {
"type": "string",
"enum": [
"async",
"async_except_on_cache_miss",
"blocking",
"force_async",
"force_blocking",
"force_cache",
"lazy_async"
],
"default": "force_cache"
},
"description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_insights_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_insights_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedInsight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_insights_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/{id}/activity/": {
"get": {
"operationId": "environments_insights_activity_retrieve_2",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/{id}/viewed/": {
"post": {
"operationId": "environments_insights_viewed_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/activity/": {
"get": {
"operationId": "environments_insights_activity_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/cancel/": {
"post": {
"operationId": "environments_insights_cancel_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/funnel/": {
"get": {
"operationId": "environments_insights_funnel_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "environments_insights_funnel_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/funnel/correlation/": {
"get": {
"operationId": "environments_insights_funnel_correlation_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "environments_insights_funnel_correlation_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/my_last_viewed/": {
"get": {
"operationId": "environments_insights_my_last_viewed_retrieve",
"description": "Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/timing/": {
"post": {
"operationId": "environments_insights_timing_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/insights/trend/": {
"get": {
"operationId": "environments_insights_trend_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "environments_insights_trend_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/logs/attributes/": {
"get": {
"operationId": "environments_logs_attributes_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/logs/query/": {
"post": {
"operationId": "environments_logs_query_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/logs/sparkline/": {
"post": {
"operationId": "environments_logs_sparkline_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/logs/values/": {
"get": {
"operationId": "environments_logs_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/max_tools/create_and_query_insight/": {
"post": {
"operationId": "environments_max_tools_create_and_query_insight_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"json",
"txt"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
},
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persisted_folder/": {
"get": {
"operationId": "environments_persisted_folder_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersistedFolderList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_persisted_folder_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/persisted_folder/{id}/": {
"get": {
"operationId": "environments_persisted_folder_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_persisted_folder_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_persisted_folder_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_persisted_folder_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/": {
"get": {
"operationId": "environments_persons_list",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "distinct_id",
"schema": {
"type": "string"
},
"description": "Filter list by distinct id."
},
{
"in": "query",
"name": "email",
"schema": {
"type": "string"
},
"description": "Filter persons by email (exact match)",
"examples": {
"Email": {
"value": "test@test.com",
"summary": "email"
}
}
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
},
"description": "Filter Persons by person properties."
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Search persons, either by email (full text search) or distinct_id (exact match)."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersonList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersonList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/persons/{id}/": {
"get": {
"operationId": "environments_persons_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_persons_update",
"description": "Only for setting properties on the person. \"properties\" from the request data will be updated via a \"$set\" event.\nThis means that only the properties listed will be updated, but other properties won't be removed nor updated.\nIf you would like to remove a property use the `delete_property` endpoint.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_persons_partial_update",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPerson"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_persons_destroy",
"description": "Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.",
"parameters": [
{
"in": "query",
"name": "delete_events",
"schema": {
"type": "boolean",
"default": false
},
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/activity/": {
"get": {
"operationId": "environments_persons_activity_retrieve_2",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/delete_events/": {
"post": {
"operationId": "environments_persons_delete_events_create",
"description": "Queue deletion of all events associated with this person. The task runs during non-peak hours.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/delete_property/": {
"post": {
"operationId": "environments_persons_delete_property_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "$unset",
"schema": {
"type": "string"
},
"description": "Specify the property key to delete",
"required": true
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/properties_timeline/": {
"get": {
"operationId": "environments_persons_properties_timeline_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/split/": {
"post": {
"operationId": "environments_persons_split_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/{id}/update_property/": {
"post": {
"operationId": "environments_persons_update_property_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "query",
"name": "key",
"schema": {
"type": "string"
},
"description": "Specify the property key",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "value",
"schema": {},
"description": "Specify the property value",
"required": true
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/activity/": {
"get": {
"operationId": "environments_persons_activity_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/bulk_delete/": {
"post": {
"operationId": "environments_persons_bulk_delete_create",
"description": "This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call.",
"parameters": [
{
"in": "query",
"name": "delete_events",
"schema": {
"type": "boolean",
"default": false
},
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
{
"in": "query",
"name": "distinct_ids",
"schema": {
"type": "object",
"additionalProperties": {}
},
"description": "A list of distinct IDs, up to 1000 of them. We'll delete all persons associated with those distinct IDs."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "ids",
"schema": {
"type": "object",
"additionalProperties": {}
},
"description": "A list of PostHog person IDs, up to 1000 of them. We'll delete all the persons listed."
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/cohorts/": {
"get": {
"operationId": "environments_persons_cohorts_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read",
"cohort:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/funnel/": {
"get": {
"operationId": "environments_persons_funnel_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "environments_persons_funnel_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/funnel/correlation/": {
"get": {
"operationId": "environments_persons_funnel_correlation_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "environments_persons_funnel_correlation_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/lifecycle/": {
"get": {
"operationId": "environments_persons_lifecycle_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/reset_person_distinct_id/": {
"post": {
"operationId": "environments_persons_reset_person_distinct_id_create",
"description": "Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/stickiness/": {
"get": {
"operationId": "environments_persons_stickiness_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/trends/": {
"get": {
"operationId": "environments_persons_trends_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/persons/values/": {
"get": {
"operationId": "environments_persons_values_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/plugin_configs/{plugin_config_id}/logs/": {
"get": {
"operationId": "environments_plugin_configs_logs_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPluginLogEntryList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/query/": {
"post": {
"operationId": "environments_query_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseAlternative"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/query/{id}/": {
"get": {
"operationId": "environments_query_retrieve",
"description": "(Experimental)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryStatusResponse"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_query_destroy",
"description": "(Experimental)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"204": {
"description": "Query cancelled"
}
}
}
},
"/api/environments/{project_id}/query/check_auth_for_async/": {
"post": {
"operationId": "environments_query_check_auth_for_async_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/query/draft_sql/": {
"get": {
"operationId": "environments_query_draft_sql_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/session_recording_playlists/": {
"get": {
"operationId": "environments_session_recording_playlists_list",
"parameters": [
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "short_id",
"schema": {
"type": "string"
}
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSessionRecordingPlaylistList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_session_recording_playlists_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/session_recording_playlists/{short_id}/": {
"get": {
"operationId": "environments_session_recording_playlists_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_session_recording_playlists_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_session_recording_playlists_partial_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_session_recording_playlists_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/session_recording_playlists/{short_id}/recordings/": {
"get": {
"operationId": "environments_session_recording_playlists_recordings_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/": {
"post": {
"operationId": "environments_session_recording_playlists_recordings_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "session_recording_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"delete": {
"operationId": "environments_session_recording_playlists_recordings_destroy",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "session_recording_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/session_recordings/": {
"get": {
"operationId": "environments_session_recordings_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSessionRecordingList"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/session_recordings/{id}/": {
"get": {
"operationId": "environments_session_recordings_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_session_recordings_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_session_recordings_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_session_recordings_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/session_recordings/{recording_id}/sharing/": {
"get": {
"operationId": "environments_session_recordings_sharing_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "recording_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/sessions/property_definitions/": {
"get": {
"operationId": "environments_sessions_property_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/sessions/values/": {
"get": {
"operationId": "environments_sessions_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/subscriptions/": {
"get": {
"operationId": "environments_subscriptions_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSubscriptionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_subscriptions_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/subscriptions/{id}/": {
"get": {
"operationId": "environments_subscriptions_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_subscriptions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_subscriptions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_subscriptions_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/user_interviews/": {
"get": {
"operationId": "environments_user_interviews_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedUserInterviewList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_user_interviews_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/user_interviews/{id}/": {
"get": {
"operationId": "environments_user_interviews_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this user interview.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_user_interviews_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this user interview.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_user_interviews_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this user interview.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUserInterview"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUserInterview"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInterview"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_user_interviews_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this user interview.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"user_interview_DO_NOT_USE:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/": {
"get": {
"operationId": "environments_warehouse_saved_queries_list",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"name": "page",
"required": false,
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataWarehouseSavedQueryList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_warehouse_saved_queries_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/": {
"get": {
"operationId": "environments_warehouse_saved_queries_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_warehouse_saved_queries_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_warehouse_saved_queries_partial_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_warehouse_saved_queries_destroy",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/activity/": {
"get": {
"operationId": "environments_warehouse_saved_queries_activity_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/ancestors/": {
"post": {
"operationId": "environments_warehouse_saved_queries_ancestors_create",
"description": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/cancel/": {
"post": {
"operationId": "environments_warehouse_saved_queries_cancel_create",
"description": "Cancel a running saved query workflow.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/descendants/": {
"post": {
"operationId": "environments_warehouse_saved_queries_descendants_create",
"description": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/revert_materialization/": {
"post": {
"operationId": "environments_warehouse_saved_queries_revert_materialization_create",
"description": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_saved_queries/{id}/run/": {
"post": {
"operationId": "environments_warehouse_saved_queries_run_create",
"description": "Run this saved query.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_tables/": {
"get": {
"operationId": "environments_warehouse_tables_list",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTableList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_warehouse_tables_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
}
},
"/api/environments/{project_id}/warehouse_tables/{id}/": {
"get": {
"operationId": "environments_warehouse_tables_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_warehouse_tables_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_warehouse_tables_partial_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_warehouse_tables_destroy",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/warehouse_tables/{id}/refresh_schema/": {
"post": {
"operationId": "environments_warehouse_tables_refresh_schema_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/warehouse_tables/{id}/update_schema/": {
"post": {
"operationId": "environments_warehouse_tables_update_schema_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/warehouse_tables/file/": {
"post": {
"operationId": "environments_warehouse_tables_file_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/environments/{project_id}/web_vitals/": {
"get": {
"operationId": "environments_web_vitals_retrieve",
"parameters": [
{
"in": "query",
"name": "pathname",
"schema": {
"type": "string"
},
"description": "Filter web vitals by pathname",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments",
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/": {
"get": {
"operationId": "list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"organizations",
"organizations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrganizationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "create",
"tags": [
"organizations",
"organizations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{id}/": {
"get": {
"operationId": "retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this organization.",
"required": true
}
],
"tags": [
"organizations",
"organizations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this organization.",
"required": true
}
],
"tags": [
"organizations",
"organizations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this organization.",
"required": true
}
],
"tags": [
"organizations",
"organizations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganization"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganization"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganization"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Organization"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this organization.",
"required": true
}
],
"tags": [
"organizations",
"organizations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/": {
"get": {
"operationId": "batch_exports_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "batch_exports_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/": {
"get": {
"operationId": "batch_exports_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "batch_exports_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "batch_exports_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "batch_exports_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/backfill/": {
"post": {
"operationId": "batch_exports_backfill_create",
"description": "Trigger a backfill for a BatchExport.\n\nNote: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/logs/": {
"get": {
"operationId": "batch_exports_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/pause/": {
"post": {
"operationId": "batch_exports_pause_create",
"description": "Pause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/run_test_step/": {
"post": {
"operationId": "batch_exports_run_test_step_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/{id}/unpause/": {
"post": {
"operationId": "batch_exports_unpause_create",
"description": "Unpause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/run_test_step_new/": {
"post": {
"operationId": "batch_exports_run_test_step_new_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/batch_exports/test/": {
"get": {
"operationId": "batch_exports_test_retrieve",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/domains/": {
"get": {
"operationId": "domains_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrganizationDomainList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "domains_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/domains/{id}/": {
"get": {
"operationId": "domains_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this domain.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "domains_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this domain.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "domains_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this domain.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationDomain"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationDomain"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationDomain"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "domains_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this domain.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/domains/{id}/verify/": {
"post": {
"operationId": "domains_verify_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this domain.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"domains"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationDomain"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/invites/": {
"get": {
"operationId": "invites_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"invites"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrganizationInviteList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "invites_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"invites"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/invites/{id}/": {
"delete": {
"operationId": "invites_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this organization invite.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"invites"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/invites/bulk/": {
"post": {
"operationId": "invites_bulk_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"invites"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationInvite"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/members/": {
"get": {
"operationId": "members_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"members"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOrganizationMemberList"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/members/{user__uuid}/": {
"put": {
"operationId": "members_update",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"members"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "members_partial_update",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"members"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedOrganizationMember"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "members_destroy",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"members"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization_member:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/members/{user__uuid}/scoped_api_keys/": {
"get": {
"operationId": "members_scoped_api_keys_retrieve",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"members"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationMember"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/": {
"get": {
"operationId": "list_2",
"description": "Projects for the current organization.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProjectBackwardCompatBasicList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "create_2",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/": {
"get": {
"operationId": "retrieve_2",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "update_2",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "partial_update_2",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"project:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "destroy_2",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/activity/": {
"get": {
"operationId": "activity_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/add_product_intent/": {
"patch": {
"operationId": "add_product_intent_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/authenticate_wizard/": {
"post": {
"operationId": "authenticate_wizard_create",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/change_organization/": {
"post": {
"operationId": "change_organization_create",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/complete_product_onboarding/": {
"patch": {
"operationId": "complete_product_onboarding_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/delete_secret_token_backup/": {
"patch": {
"operationId": "delete_secret_token_backup_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/is_generating_demo_data/": {
"get": {
"operationId": "is_generating_demo_data_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/reset_token/": {
"patch": {
"operationId": "reset_token_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/projects/{id}/rotate_secret_token/": {
"patch": {
"operationId": "rotate_secret_token_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer",
"maximum": 9223372036854776000,
"minimum": -9223372036854776000,
"format": "int64"
},
"description": "A unique value identifying this project.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"projects"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProjectBackwardCompat"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProjectBackwardCompat"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/proxy_records/": {
"get": {
"operationId": "proxy_records_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedProxyRecordList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "proxy_records_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/proxy_records/{id}/": {
"get": {
"operationId": "proxy_records_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "proxy_records_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "proxy_records_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedProxyRecord"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedProxyRecord"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedProxyRecord"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProxyRecord"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "proxy_records_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"organizations",
"proxy_records"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/roles/": {
"get": {
"operationId": "roles_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRoleList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "roles_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Role"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/roles/{id}/": {
"get": {
"operationId": "roles_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this role.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "roles_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this role.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Role"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "roles_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this role.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedRole"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedRole"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedRole"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Role"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "roles_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this role.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/organizations/{organization_id}/roles/{role_id}/role_memberships/": {
"get": {
"operationId": "roles_role_memberships_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "role_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedRoleMembershipList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "roles_role_memberships_create",
"parameters": [
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "role_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleMembership"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RoleMembership"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RoleMembership"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleMembership"
}
}
},
"description": ""
}
}
}
},
"/api/organizations/{organization_id}/roles/{role_id}/role_memberships/{id}/": {
"delete": {
"operationId": "roles_role_memberships_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this role membership.",
"required": true
},
{
"in": "path",
"name": "organization_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "role_id",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"organizations",
"roles"
],
"security": [
{
"PersonalAPIKeyAuth": [
"organization:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/actions/": {
"get": {
"operationId": "actions_list",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"action:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedActionList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedActionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "actions_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"action:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/actions/{id}/": {
"get": {
"operationId": "actions_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this action.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"action:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "actions_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this action.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"action:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "actions_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this action.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedAction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedAction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedAction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"action:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Action"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Action"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "actions_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this action.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"actions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"action:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/activity_log/": {
"get": {
"operationId": "activity_log_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"activity_log"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedActivityLogList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/activity_log/bookmark_activity_notification/": {
"post": {
"operationId": "activity_log_bookmark_activity_notification_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"activity_log"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityLog"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ActivityLog"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ActivityLog"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/activity_log/important_changes/": {
"get": {
"operationId": "activity_log_important_changes_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"activity_log"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/annotations/": {
"get": {
"operationId": "annotations_list",
"description": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"annotations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedAnnotationList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "annotations_create",
"description": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"annotations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/annotations/{id}/": {
"get": {
"operationId": "annotations_retrieve",
"description": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this annotation.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"annotations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "annotations_update",
"description": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this annotation.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"annotations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "annotations_partial_update",
"description": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/user-guides/annotations) for more information on annotations.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this annotation.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"annotations"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedAnnotation"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedAnnotation"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedAnnotation"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Annotation"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "annotations_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this annotation.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"annotations"
],
"security": [
{
"PersonalAPIKeyAuth": [
"annotation:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/app_metrics/{id}/": {
"get": {
"operationId": "app_metrics_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this plugin config.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"app_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/app_metrics/{id}/error_details/": {
"get": {
"operationId": "app_metrics_error_details_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this plugin config.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"app_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/": {
"get": {
"operationId": "app_metrics_historical_exports_retrieve",
"parameters": [
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"app_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/{id}/": {
"get": {
"operationId": "app_metrics_historical_exports_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"app_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/": {
"get": {
"operationId": "batch_exports_list_2",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "batch_exports_create_2",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/": {
"get": {
"operationId": "batch_exports_backfills_list",
"description": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportBackfillList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "batch_exports_backfills_create",
"description": "Create a new backfill for a BatchExport.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/": {
"get": {
"operationId": "batch_exports_backfills_retrieve",
"description": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export backfill.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/backfills/{id}/cancel/": {
"post": {
"operationId": "batch_exports_backfills_cancel_create",
"description": "Cancel a batch export backfill.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this backfill belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export backfill.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportBackfill"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/": {
"get": {
"operationId": "batch_exports_runs_list",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"name": "ordering",
"required": false,
"in": "query",
"description": "Which field to use when ordering the results.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedBatchExportRunList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/": {
"get": {
"operationId": "batch_exports_runs_retrieve",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/cancel/": {
"post": {
"operationId": "batch_exports_runs_cancel_create",
"description": "Cancel a batch export run.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/logs/": {
"get": {
"operationId": "batch_exports_runs_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{batch_export_id}/runs/{id}/retry/": {
"post": {
"operationId": "batch_exports_runs_retry_create",
"description": "Retry a batch export run.\n\nWe use the same underlying mechanism as when backfilling a batch export, as retrying\na run is the same as backfilling one run.",
"parameters": [
{
"in": "path",
"name": "batch_export_id",
"schema": {
"type": "string",
"format": "uuid",
"description": "The BatchExport this run belongs to."
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export run.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExportRun"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/": {
"get": {
"operationId": "batch_exports_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "batch_exports_update_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "batch_exports_partial_update_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedBatchExport"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "batch_exports_destroy_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/backfill/": {
"post": {
"operationId": "batch_exports_backfill_create_2",
"description": "Trigger a backfill for a BatchExport.\n\nNote: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/logs/": {
"get": {
"operationId": "batch_exports_logs_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/pause/": {
"post": {
"operationId": "batch_exports_pause_create_2",
"description": "Pause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/run_test_step/": {
"post": {
"operationId": "batch_exports_run_test_step_create_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/{id}/unpause/": {
"post": {
"operationId": "batch_exports_unpause_create_2",
"description": "Unpause a BatchExport.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this batch export.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"batch_export:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/run_test_step_new/": {
"post": {
"operationId": "batch_exports_run_test_step_new_create_2",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BatchExport"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/batch_exports/test/": {
"get": {
"operationId": "batch_exports_test_retrieve_2",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"batch_exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"INTERNAL"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/cohorts/": {
"get": {
"operationId": "cohorts_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedCohortList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "cohorts_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/cohorts/{id}/": {
"get": {
"operationId": "cohorts_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "cohorts_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "cohorts_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedCohort"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedCohort"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedCohort"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cohort"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "cohorts_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/cohorts/{id}/activity/": {
"get": {
"operationId": "cohorts_activity_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/cohorts/{id}/duplicate_as_static_cohort/": {
"get": {
"operationId": "cohorts_duplicate_as_static_cohort_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/cohorts/{id}/persons/": {
"get": {
"operationId": "cohorts_persons_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this cohort.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"cohort:read",
"person:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/cohorts/activity/": {
"get": {
"operationId": "cohorts_activity_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"cohorts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboard_templates/": {
"get": {
"operationId": "dashboard_templates_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDashboardTemplateList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dashboard_templates_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/dashboard_templates/{id}/": {
"get": {
"operationId": "dashboard_templates_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this dashboard template.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dashboard_templates_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this dashboard template.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dashboard_templates_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this dashboard template.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboardTemplate"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboardTemplate"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboardTemplate"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardTemplate"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dashboard_templates_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this dashboard template.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard_template:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboard_templates/json_schema/": {
"get": {
"operationId": "dashboard_templates_json_schema_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboard_templates"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboards/": {
"get": {
"operationId": "dashboards_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDashboardBasicList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dashboards_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/": {
"get": {
"operationId": "dashboards_collaborators_list",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "dashboards_collaborators_create",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardCollaborator"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/": {
"delete": {
"operationId": "dashboards_collaborators_destroy",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboards/{dashboard_id}/sharing/": {
"get": {
"operationId": "dashboards_sharing_list",
"parameters": [
{
"in": "path",
"name": "dashboard_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/dashboards/{id}/": {
"get": {
"operationId": "dashboards_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "dashboards_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "dashboards_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "dashboards_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"security": [
{
"PersonalAPIKeyAuth": [
"dashboard:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboards/{id}/move_tile/": {
"patch": {
"operationId": "dashboards_move_tile_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this dashboard.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/dashboards/create_from_template_json/": {
"post": {
"operationId": "dashboards_create_from_template_json_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"dashboards"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Dashboard"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/early_access_feature/": {
"get": {
"operationId": "early_access_feature_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedEarlyAccessFeatureList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "early_access_feature_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeatureSerializerCreateOnly"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeatureSerializerCreateOnly"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeatureSerializerCreateOnly"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeatureSerializerCreateOnly"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/early_access_feature/{id}/": {
"get": {
"operationId": "early_access_feature_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this early access feature.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "early_access_feature_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this early access feature.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "early_access_feature_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this early access feature.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedEarlyAccessFeature"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedEarlyAccessFeature"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedEarlyAccessFeature"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EarlyAccessFeature"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "early_access_feature_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this early access feature.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"early_access_feature"
],
"security": [
{
"PersonalAPIKeyAuth": [
"early_access_feature:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/": {
"get": {
"operationId": "environments_list",
"description": "Projects for the current organization.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTeamBasicList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "environments_create",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/environments/{id}/": {
"get": {
"operationId": "environments_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "environments_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "environments_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "environments_destroy",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"project:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/activity/": {
"get": {
"operationId": "environments_activity_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/add_product_intent/": {
"patch": {
"operationId": "environments_add_product_intent_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/authenticate_wizard/": {
"post": {
"operationId": "environments_authenticate_wizard_create",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Team"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Team"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/complete_product_onboarding/": {
"patch": {
"operationId": "environments_complete_product_onboarding_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/delete_secret_token_backup/": {
"patch": {
"operationId": "environments_delete_secret_token_backup_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/event_ingestion_restrictions/": {
"get": {
"operationId": "environments_event_ingestion_restrictions_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"team:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/is_generating_demo_data/": {
"get": {
"operationId": "environments_is_generating_demo_data_retrieve",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/reset_token/": {
"patch": {
"operationId": "environments_reset_token_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/environments/{id}/rotate_secret_token/": {
"patch": {
"operationId": "environments_rotate_secret_token_partial_update",
"description": "Projects for the current organization.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this environment (aka team).",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"environments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTeam"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/event_definitions/": {
"get": {
"operationId": "event_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"event_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"event_definition:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/event_definitions/{id}/": {
"get": {
"operationId": "event_definitions_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this event definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"event_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"event_definition:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"put": {
"operationId": "event_definitions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this event definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"event_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"event_definition:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"patch": {
"operationId": "event_definitions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this event definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"event_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"event_definition:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"delete": {
"operationId": "event_definitions_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this event definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"event_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"event_definition:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/events/": {
"get": {
"operationId": "events_list",
"description": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n ",
"parameters": [
{
"in": "query",
"name": "after",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Only return events with a timestamp after this time."
},
{
"in": "query",
"name": "before",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Only return events with a timestamp before this time."
},
{
"in": "query",
"name": "distinct_id",
"schema": {
"type": "integer"
},
"description": "Filter list by distinct id."
},
{
"in": "query",
"name": "event",
"schema": {
"type": "string"
},
"description": "Filter list by event. For example `user sign up` or `$pageview`."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "limit",
"schema": {
"type": "integer"
},
"description": "The maximum number of results to return"
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "person_id",
"schema": {
"type": "integer"
},
"description": "Filter list by person id."
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
},
"description": "Filter events by event property, person property, cohort, groups and more."
},
{
"in": "query",
"name": "select",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "(Experimental) JSON-serialized array of HogQL expressions to return"
},
{
"in": "query",
"name": "where",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "(Experimental) JSON-serialized array of HogQL expressions that must pass"
}
],
"tags": [
"events"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedClickhouseEventList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedClickhouseEventList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/events/{id}/": {
"get": {
"operationId": "events_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"events"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/ClickhouseEvent"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/events/values/": {
"get": {
"operationId": "events_values_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"events"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/experiment_holdouts/": {
"get": {
"operationId": "experiment_holdouts_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExperimentHoldoutList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "experiment_holdouts_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/experiment_holdouts/{id}/": {
"get": {
"operationId": "experiment_holdouts_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment holdout.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "experiment_holdouts_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment holdout.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "experiment_holdouts_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment holdout.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentHoldout"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentHoldout"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentHoldout"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentHoldout"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "experiment_holdouts_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment holdout.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_holdouts"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/experiment_saved_metrics/": {
"get": {
"operationId": "experiment_saved_metrics_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExperimentSavedMetricList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "experiment_saved_metrics_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/experiment_saved_metrics/{id}/": {
"get": {
"operationId": "experiment_saved_metrics_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment saved metric.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "experiment_saved_metrics_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment saved metric.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "experiment_saved_metrics_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment saved metric.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentSavedMetric"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentSavedMetric"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExperimentSavedMetric"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExperimentSavedMetric"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "experiment_saved_metrics_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment saved metric.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiment_saved_metrics"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/experiments/": {
"get": {
"operationId": "experiments_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExperimentList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "experiments_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/experiments/{id}/": {
"get": {
"operationId": "experiments_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "experiments_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "experiments_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExperiment"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedExperiment"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExperiment"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "experiments_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/experiments/{id}/create_exposure_cohort_for_experiment/": {
"post": {
"operationId": "experiments_create_exposure_cohort_for_experiment_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Experiment"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/experiments/requires_flag_implementation/": {
"get": {
"operationId": "experiments_requires_flag_implementation_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/explicit_members/": {
"get": {
"operationId": "explicit_members_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "explicit_members_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/explicit_members/{parent_membership__user__uuid}/": {
"get": {
"operationId": "explicit_members_retrieve",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "explicit_members_update",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "explicit_members_partial_update",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedExplicitTeamMember"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExplicitTeamMember"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "explicit_members_destroy",
"parameters": [
{
"in": "path",
"name": "parent_membership__user__uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"explicit_members"
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/exports/": {
"get": {
"operationId": "exports_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedExportedAssetList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "exports_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"exports"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"export:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/exports/{id}/": {
"get": {
"operationId": "exports_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this exported asset.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportedAsset"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/exports/{id}/content/": {
"get": {
"operationId": "exports_content_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this exported asset.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"exports"
],
"security": [
{
"PersonalAPIKeyAuth": [
"export:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/": {
"get": {
"operationId": "feature_flags_list",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "query",
"name": "active",
"schema": {
"type": "string",
"enum": [
"false",
"true"
]
}
},
{
"in": "query",
"name": "created_by_id",
"schema": {
"type": "string"
},
"description": "The User ID which initially created the feature flag."
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Search by feature flag key or name. Case insensitive."
},
{
"in": "query",
"name": "type",
"schema": {
"type": "string",
"enum": [
"boolean",
"experiment",
"multivariant"
]
}
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFeatureFlagList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "feature_flags_create",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access/": {
"get": {
"operationId": "feature_flags_role_access_list",
"parameters": [
{
"in": "path",
"name": "feature_flag_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedFeatureFlagRoleAccessList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "feature_flags_role_access_create",
"parameters": [
{
"in": "path",
"name": "feature_flag_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/feature_flags/{feature_flag_id}/role_access/{id}/": {
"get": {
"operationId": "feature_flags_role_access_retrieve",
"parameters": [
{
"in": "path",
"name": "feature_flag_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag role access.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlagRoleAccess"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "feature_flags_role_access_destroy",
"parameters": [
{
"in": "path",
"name": "feature_flag_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag role access.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/": {
"get": {
"operationId": "feature_flags_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "feature_flags_update",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "feature_flags_partial_update",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedFeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedFeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedFeatureFlag"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "feature_flags_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/activity/": {
"get": {
"operationId": "feature_flags_activity_retrieve_2",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/create_static_cohort_for_flag/": {
"post": {
"operationId": "feature_flags_create_static_cohort_for_flag_create",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/dashboard/": {
"post": {
"operationId": "feature_flags_dashboard_create",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/enrich_usage_dashboard/": {
"post": {
"operationId": "feature_flags_enrich_usage_dashboard_create",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/remote_config/": {
"get": {
"operationId": "feature_flags_remote_config_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/{id}/status/": {
"get": {
"operationId": "feature_flags_status_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this feature flag.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/activity/": {
"get": {
"operationId": "feature_flags_activity_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/evaluation_reasons/": {
"get": {
"operationId": "feature_flags_evaluation_reasons_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/local_evaluation/": {
"get": {
"operationId": "feature_flags_local_evaluation_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": [
"feature_flag:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/my_flags/": {
"get": {
"operationId": "feature_flags_my_flags_retrieve",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/feature_flags/user_blast_radius/": {
"post": {
"operationId": "feature_flags_user_blast_radius_create",
"description": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"feature_flags"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/FeatureFlag"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/": {
"get": {
"operationId": "groups_list",
"description": "List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/",
"parameters": [
{
"name": "cursor",
"required": false,
"in": "query",
"description": "The pagination cursor value.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to list",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Search the group name",
"required": true
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedGroupList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/groups/activity/": {
"get": {
"operationId": "groups_activity_retrieve",
"parameters": [
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"description": "Specify the id of the user to find groups for",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/delete_property/": {
"post": {
"operationId": "groups_delete_property_create",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"group:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/find/": {
"get": {
"operationId": "groups_find_retrieve",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/property_definitions/": {
"get": {
"operationId": "groups_property_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/property_values/": {
"get": {
"operationId": "groups_property_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/related/": {
"get": {
"operationId": "groups_related_retrieve",
"parameters": [
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string"
},
"description": "Specify the id of the user to find groups for",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups/update_property/": {
"post": {
"operationId": "groups_update_property_create",
"parameters": [
{
"in": "query",
"name": "group_key",
"schema": {
"type": "string"
},
"description": "Specify the key of the group to find",
"required": true
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "Specify the group type to find",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Group"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Group"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"group:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups_types/": {
"get": {
"operationId": "groups_types_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups_types"
],
"security": [
{
"PersonalAPIKeyAuth": [
"group:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupType"
}
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/groups_types/create_detail_dashboard/": {
"put": {
"operationId": "groups_types_create_detail_dashboard_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups_types"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups_types/set_default_columns/": {
"put": {
"operationId": "groups_types_set_default_columns_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups_types"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GroupType"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/groups_types/update_metadata/": {
"patch": {
"operationId": "groups_types_update_metadata_partial_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"groups_types"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedGroupType"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedGroupType"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedGroupType"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/": {
"get": {
"operationId": "hog_functions_list",
"parameters": [
{
"in": "query",
"name": "created_at",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "enabled",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "exclude_kind",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "kind",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "type",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "Multiple values may be separated by commas.",
"explode": false,
"style": "form"
},
{
"in": "query",
"name": "updated_at",
"schema": {
"type": "string",
"format": "date-time"
}
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedHogFunctionMinimalList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "hog_functions_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/": {
"get": {
"operationId": "hog_functions_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "hog_functions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "hog_functions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "hog_functions_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"hog_function:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/broadcast/": {
"post": {
"operationId": "hog_functions_broadcast_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/invocations/": {
"post": {
"operationId": "hog_functions_invocations_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/HogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/logs/": {
"get": {
"operationId": "hog_functions_logs_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/metrics/": {
"get": {
"operationId": "hog_functions_metrics_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/{id}/metrics/totals/": {
"get": {
"operationId": "hog_functions_metrics_totals_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this hog function.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/icon/": {
"get": {
"operationId": "hog_functions_icon_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/icons/": {
"get": {
"operationId": "hog_functions_icons_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/hog_functions/rearrange/": {
"patch": {
"operationId": "hog_functions_rearrange_partial_update",
"description": "Update the execution order of multiple HogFunctions.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"hog_functions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedHogFunction"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/": {
"get": {
"operationId": "insights_list",
"parameters": [
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "refresh",
"schema": {
"type": "string",
"enum": [
"async",
"async_except_on_cache_miss",
"blocking",
"force_async",
"force_blocking",
"force_cache",
"lazy_async"
],
"default": "force_cache"
},
"description": "\nWhether to refresh the retrieved insights, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field."
},
{
"in": "query",
"name": "short_id",
"schema": {
"type": "string"
}
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedInsightList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedInsightList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "insights_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/insights/{insight_id}/sharing/": {
"get": {
"operationId": "insights_sharing_list",
"parameters": [
{
"in": "path",
"name": "insight_id",
"schema": {
"type": "integer"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/insights/{id}/": {
"get": {
"operationId": "insights_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "from_dashboard",
"schema": {
"type": "integer"
},
"description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied."
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "refresh",
"schema": {
"type": "string",
"enum": [
"async",
"async_except_on_cache_miss",
"blocking",
"force_async",
"force_blocking",
"force_cache",
"lazy_async"
],
"default": "force_cache"
},
"description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "insights_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "insights_partial_update",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedInsight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "insights_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/{id}/activity/": {
"get": {
"operationId": "insights_activity_retrieve_2",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/{id}/viewed/": {
"post": {
"operationId": "insights_viewed_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this insight.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/activity/": {
"get": {
"operationId": "insights_activity_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/cancel/": {
"post": {
"operationId": "insights_cancel_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/funnel/": {
"get": {
"operationId": "insights_funnel_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "insights_funnel_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/funnel/correlation/": {
"get": {
"operationId": "insights_funnel_correlation_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "insights_funnel_correlation_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/my_last_viewed/": {
"get": {
"operationId": "insights_my_last_viewed_retrieve",
"description": "Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/timing/": {
"post": {
"operationId": "insights_timing_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/insights/trend/": {
"get": {
"operationId": "insights_trend_retrieve",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "insights_trend_create",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"insights"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Insight"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"insight:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/logs/attributes/": {
"get": {
"operationId": "logs_attributes_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"logs"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/logs/query/": {
"post": {
"operationId": "logs_query_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"logs"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/logs/sparkline/": {
"post": {
"operationId": "logs_sparkline_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"logs"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/logs/values/": {
"get": {
"operationId": "logs_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"logs"
],
"security": [
{
"PersonalAPIKeyAuth": [
"error_tracking:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/notebooks/": {
"get": {
"operationId": "notebooks_list",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "query",
"name": "contains",
"schema": {
"type": "string"
},
"description": "Filter for notebooks that match a provided filter.\n Each match pair is separated by a colon,\n multiple match pairs can be sent separated by a space or a comma",
"examples": {
"FilterForNotebooksThatHaveAnyRecording": {
"value": "recording:true",
"summary": "Filter for notebooks that have any recording"
},
"FilterForNotebooksThatDoNotHaveAnyRecording": {
"value": "recording:false",
"summary": "Filter for notebooks that do not have any recording"
},
"FilterForNotebooksThatHaveASpecificRecording": {
"value": "recording:the-session-recording-id",
"summary": "Filter for notebooks that have a specific recording"
}
}
},
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
},
"description": "The UUID of the Notebook's creator"
},
{
"in": "query",
"name": "date_from",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Filter for notebooks created after this date & time"
},
{
"in": "query",
"name": "date_to",
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Filter for notebooks created before this date & time"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "user",
"schema": {
"type": "string"
},
"description": "If any value is provided for this parameter, return notebooks created by the logged in user."
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedNotebookMinimalList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "notebooks_create",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"notebooks"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/notebooks/{short_id}/": {
"get": {
"operationId": "notebooks_retrieve",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "notebooks_update",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"notebooks"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "notebooks_partial_update",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"notebooks"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedNotebook"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedNotebook"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedNotebook"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Notebook"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "notebooks_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": [
"notebook:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/notebooks/{short_id}/activity/": {
"get": {
"operationId": "notebooks_activity_retrieve_2",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/notebooks/activity/": {
"get": {
"operationId": "notebooks_activity_retrieve",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/notebooks/recording_comments/": {
"get": {
"operationId": "notebooks_recording_comments_retrieve",
"description": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"notebooks"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persisted_folder/": {
"get": {
"operationId": "persisted_folder_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersistedFolderList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "persisted_folder_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/persisted_folder/{id}/": {
"get": {
"operationId": "persisted_folder_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "persisted_folder_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "persisted_folder_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPersistedFolder"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersistedFolder"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "persisted_folder_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this Persisted Folder.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persisted_folder"
],
"security": [
{
"PersonalAPIKeyAuth": [
"persisted_folder:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/": {
"get": {
"operationId": "persons_list",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "distinct_id",
"schema": {
"type": "string"
},
"description": "Filter list by distinct id."
},
{
"in": "query",
"name": "email",
"schema": {
"type": "string"
},
"description": "Filter persons by email (exact match)",
"examples": {
"Email": {
"value": "test@test.com",
"summary": "email"
}
}
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Property"
}
},
"description": "Filter Persons by person properties."
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Search persons, either by email (full text search) or distinct_id (exact match)."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersonList"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/PaginatedPersonList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/persons/{id}/": {
"get": {
"operationId": "persons_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "persons_update",
"description": "Only for setting properties on the person. \"properties\" from the request data will be updated via a \"$set\" event.\nThis means that only the properties listed will be updated, but other properties won't be removed nor updated.\nIf you would like to remove a property use the `delete_property` endpoint.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "persons_partial_update",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPerson"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "persons_destroy",
"description": "Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.",
"parameters": [
{
"in": "query",
"name": "delete_events",
"schema": {
"type": "boolean",
"default": false
},
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/activity/": {
"get": {
"operationId": "persons_activity_retrieve_2",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/delete_events/": {
"post": {
"operationId": "persons_delete_events_create",
"description": "Queue deletion of all events associated with this person. The task runs during non-peak hours.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/delete_property/": {
"post": {
"operationId": "persons_delete_property_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "$unset",
"schema": {
"type": "string"
},
"description": "Specify the property key to delete",
"required": true
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/properties_timeline/": {
"get": {
"operationId": "persons_properties_timeline_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/split/": {
"post": {
"operationId": "persons_split_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/{id}/update_property/": {
"post": {
"operationId": "persons_update_property_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this person.",
"required": true
},
{
"in": "query",
"name": "key",
"schema": {
"type": "string"
},
"description": "Specify the property key",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "value",
"schema": {},
"description": "Specify the property value",
"required": true
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/activity/": {
"get": {
"operationId": "persons_activity_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/bulk_delete/": {
"post": {
"operationId": "persons_bulk_delete_create",
"description": "This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call.",
"parameters": [
{
"in": "query",
"name": "delete_events",
"schema": {
"type": "boolean",
"default": false
},
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
{
"in": "query",
"name": "distinct_ids",
"schema": {
"type": "object",
"additionalProperties": {}
},
"description": "A list of distinct IDs, up to 1000 of them. We'll delete all persons associated with those distinct IDs."
},
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "query",
"name": "ids",
"schema": {
"type": "object",
"additionalProperties": {}
},
"description": "A list of PostHog person IDs, up to 1000 of them. We'll delete all the persons listed."
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/cohorts/": {
"get": {
"operationId": "persons_cohorts_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read",
"cohort:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/funnel/": {
"get": {
"operationId": "persons_funnel_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "persons_funnel_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/funnel/correlation/": {
"get": {
"operationId": "persons_funnel_correlation_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"post": {
"operationId": "persons_funnel_correlation_create",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/lifecycle/": {
"get": {
"operationId": "persons_lifecycle_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/reset_person_distinct_id/": {
"post": {
"operationId": "persons_reset_person_distinct_id_create",
"description": "Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Person"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"person:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/stickiness/": {
"get": {
"operationId": "persons_stickiness_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/trends/": {
"get": {
"operationId": "persons_trends_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/persons/values/": {
"get": {
"operationId": "persons_values_retrieve",
"description": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs.",
"parameters": [
{
"in": "query",
"name": "format",
"schema": {
"type": "string",
"enum": [
"csv",
"json"
]
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"persons"
],
"security": [
{
"PersonalAPIKeyAuth": [
"person:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/plugin_configs/{plugin_config_id}/logs/": {
"get": {
"operationId": "plugin_configs_logs_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "plugin_config_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"plugin_configs"
],
"security": [
{
"PersonalAPIKeyAuth": [
"plugin:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPluginLogEntryList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/property_definitions/": {
"get": {
"operationId": "property_definitions_list",
"parameters": [
{
"in": "query",
"name": "event_names",
"schema": {
"type": "string",
"minLength": 1
},
"description": "If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded"
},
{
"in": "query",
"name": "exclude_core_properties",
"schema": {
"type": "boolean",
"default": false
},
"description": "Whether to exclude core properties"
},
{
"in": "query",
"name": "exclude_hidden",
"schema": {
"type": "boolean",
"default": false
},
"description": "Whether to exclude properties marked as hidden"
},
{
"in": "query",
"name": "excluded_properties",
"schema": {
"type": "string",
"minLength": 1
},
"description": "JSON-encoded list of excluded properties"
},
{
"in": "query",
"name": "filter_by_event_names",
"schema": {
"type": "boolean",
"nullable": true
},
"description": "Whether to return only properties for events in `event_names`"
},
{
"in": "query",
"name": "group_type_index",
"schema": {
"type": "integer"
},
"description": "What group type is the property for. Only should be set if `type=group`"
},
{
"in": "query",
"name": "is_feature_flag",
"schema": {
"type": "boolean",
"nullable": true
},
"description": "Whether to return only (or excluding) feature flag properties"
},
{
"in": "query",
"name": "is_numerical",
"schema": {
"type": "boolean",
"nullable": true
},
"description": "Whether to return only (or excluding) numerical property definitions"
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "properties",
"schema": {
"type": "string",
"minLength": 1
},
"description": "Comma-separated list of properties to filter"
},
{
"in": "query",
"name": "search",
"schema": {
"type": "string"
},
"description": "Searches properties by name"
},
{
"in": "query",
"name": "type",
"schema": {
"enum": [
"event",
"person",
"group",
"session"
],
"type": "string",
"default": "event",
"minLength": 1
},
"description": "What property definitions to return\n\n* `event` - event\n* `person` - person\n* `group` - group\n* `session` - session"
}
],
"tags": [
"property_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPropertyDefinitionList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/property_definitions/{id}/": {
"get": {
"operationId": "property_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this property definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"property_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "property_definitions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this property definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"property_definitions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "property_definitions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this property definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"property_definitions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPropertyDefinition"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedPropertyDefinition"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPropertyDefinition"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PropertyDefinition"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "property_definitions_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this property definition.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"property_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/property_definitions/seen_together/": {
"get": {
"operationId": "property_definitions_seen_together_retrieve",
"description": "Allows a caller to provide a list of event names and a single property name\nReturns a map of the event names to a boolean representing whether that property has ever been seen with that event_name",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"property_definitions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"property_definition:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/query/": {
"post": {
"operationId": "query_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"query"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/QueryRequest"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryResponseAlternative"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/query/{id}/": {
"get": {
"operationId": "query_retrieve",
"description": "(Experimental)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"query"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueryStatusResponse"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "query_destroy",
"description": "(Experimental)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"query"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"204": {
"description": "Query cancelled"
}
}
}
},
"/api/projects/{project_id}/query/check_auth_for_async/": {
"post": {
"operationId": "query_check_auth_for_async_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"query"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/query/draft_sql/": {
"get": {
"operationId": "query_draft_sql_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"query"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/session_recording_playlists/": {
"get": {
"operationId": "session_recording_playlists_list",
"parameters": [
{
"in": "query",
"name": "created_by",
"schema": {
"type": "integer"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "query",
"name": "short_id",
"schema": {
"type": "string"
}
}
],
"tags": [
"session_recording_playlists"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSessionRecordingPlaylistList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "session_recording_playlists_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recording_playlists"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/session_recording_playlists/{short_id}/": {
"get": {
"operationId": "session_recording_playlists_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "session_recording_playlists_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "session_recording_playlists_partial_update",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "session_recording_playlists_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording_playlist:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/": {
"get": {
"operationId": "session_recording_playlists_recordings_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/session_recording_playlists/{short_id}/recordings/{session_recording_id}/": {
"post": {
"operationId": "session_recording_playlists_recordings_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "session_recording_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecordingPlaylist"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"delete": {
"operationId": "session_recording_playlists_recordings_destroy",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "session_recording_id",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "path",
"name": "short_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recording_playlists"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/session_recordings/": {
"get": {
"operationId": "session_recordings_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recordings"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSessionRecordingList"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/session_recordings/{id}/": {
"get": {
"operationId": "session_recordings_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recordings"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "session_recordings_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recordings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "session_recordings_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recordings"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSessionRecording"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionRecording"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "session_recordings_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this session recording.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"session_recordings"
],
"security": [
{
"PersonalAPIKeyAuth": [
"session_recording:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/session_recordings/{recording_id}/sharing/": {
"get": {
"operationId": "session_recordings_sharing_list",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"in": "path",
"name": "recording_id",
"schema": {
"type": "string"
},
"required": true
}
],
"tags": [
"session_recordings"
],
"security": [
{
"PersonalAPIKeyAuth": [
"sharing_configuration:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharingConfiguration"
}
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/sessions/property_definitions/": {
"get": {
"operationId": "sessions_property_definitions_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"sessions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/sessions/values/": {
"get": {
"operationId": "sessions_values_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"sessions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"query:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/subscriptions/": {
"get": {
"operationId": "subscriptions_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSubscriptionList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "subscriptions_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/subscriptions/{id}/": {
"get": {
"operationId": "subscriptions_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "subscriptions_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "subscriptions_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSubscription"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "subscriptions_destroy",
"description": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this subscription.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"subscriptions"
],
"security": [
{
"PersonalAPIKeyAuth": [
"subscription:write"
]
}
],
"responses": {
"405": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/": {
"get": {
"operationId": "surveys_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSurveyList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "surveys_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"survey:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/surveys/{id}/": {
"get": {
"operationId": "surveys_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Survey"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "surveys_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Survey"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Survey"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Survey"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"survey:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Survey"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "surveys_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedSurveySerializerCreateUpdateOnly"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedSurveySerializerCreateUpdateOnly"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedSurveySerializerCreateUpdateOnly"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"survey:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "surveys_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/{id}/activity/": {
"get": {
"operationId": "surveys_activity_retrieve_2",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/{id}/stats/": {
"get": {
"operationId": "surveys_stats_retrieve_2",
"description": "Get survey response statistics for a specific survey.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n\nReturns:\n Survey statistics including event counts, unique respondents, and conversion rates",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/{id}/summarize_responses/": {
"post": {
"operationId": "surveys_summarize_responses_create",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this survey.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/SurveySerializerCreateUpdateOnly"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/activity/": {
"get": {
"operationId": "surveys_activity_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/responses_count/": {
"get": {
"operationId": "surveys_responses_count_retrieve",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/surveys/stats/": {
"get": {
"operationId": "surveys_stats_retrieve",
"description": "Get aggregated response statistics across all surveys.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n\nReturns:\n Aggregated statistics across all surveys including total counts and rates",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"surveys"
],
"security": [
{
"PersonalAPIKeyAuth": [
"survey:read"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/": {
"get": {
"operationId": "warehouse_saved_queries_list",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"name": "page",
"required": false,
"in": "query",
"description": "A page number within the paginated result set.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"warehouse_saved_queries"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedDataWarehouseSavedQueryList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "warehouse_saved_queries_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/": {
"get": {
"operationId": "warehouse_saved_queries_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "warehouse_saved_queries_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "warehouse_saved_queries_partial_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedDataWarehouseSavedQuery"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "warehouse_saved_queries_destroy",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_view:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/activity/": {
"get": {
"operationId": "warehouse_saved_queries_activity_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"security": [
{
"PersonalAPIKeyAuth": [
"activity_log:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/ancestors/": {
"post": {
"operationId": "warehouse_saved_queries_ancestors_create",
"description": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/cancel/": {
"post": {
"operationId": "warehouse_saved_queries_cancel_create",
"description": "Cancel a running saved query workflow.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/descendants/": {
"post": {
"operationId": "warehouse_saved_queries_descendants_create",
"description": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/revert_materialization/": {
"post": {
"operationId": "warehouse_saved_queries_revert_materialization_create",
"description": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_saved_queries/{id}/run/": {
"post": {
"operationId": "warehouse_saved_queries_run_create",
"description": "Run this saved query.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse saved query.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_saved_queries"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DataWarehouseSavedQuery"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_tables/": {
"get": {
"operationId": "warehouse_tables_list",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
},
{
"name": "search",
"required": false,
"in": "query",
"description": "A search term.",
"schema": {
"type": "string"
}
}
],
"tags": [
"warehouse_tables"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedTableList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "warehouse_tables_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/warehouse_tables/{id}/": {
"get": {
"operationId": "warehouse_tables_retrieve",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "warehouse_tables_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "warehouse_tables_partial_update",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedTable"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "warehouse_tables_destroy",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/warehouse_tables/{id}/refresh_schema/": {
"post": {
"operationId": "warehouse_tables_refresh_schema_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/warehouse_tables/{id}/update_schema/": {
"post": {
"operationId": "warehouse_tables_update_schema_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"format": "uuid"
},
"description": "A UUID string identifying this data warehouse table.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/warehouse_tables/file/": {
"post": {
"operationId": "warehouse_tables_file_create",
"description": "Create, Read, Update and Delete Warehouse Tables.",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"warehouse_tables"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Table"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/Table"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"warehouse_table:write"
]
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/projects/{project_id}/web_experiments/": {
"get": {
"operationId": "web_experiments_list",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedWebExperimentsAPIList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "web_experiments_create",
"parameters": [
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"description": ""
}
}
}
},
"/api/projects/{project_id}/web_experiments/{id}/": {
"get": {
"operationId": "web_experiments_retrieve",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this web experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "web_experiments_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this web experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "web_experiments_partial_update",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this web experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedWebExperimentsAPI"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedWebExperimentsAPI"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedWebExperimentsAPI"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebExperimentsAPI"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "web_experiments_destroy",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this web experiment.",
"required": true
},
{
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/."
}
],
"tags": [
"web_experiments"
],
"security": [
{
"PersonalAPIKeyAuth": [
"experiment:write"
]
}
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/": {
"get": {
"operationId": "users_list",
"parameters": [
{
"in": "query",
"name": "is_staff",
"schema": {
"type": "boolean"
}
},
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": [
"user:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedUserList"
}
}
},
"description": ""
}
}
}
},
"/api/users/{uuid}/": {
"get": {
"operationId": "users_retrieve",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": [
"user:read"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_update",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": [
"user:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_partial_update",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": [
"user:write"
]
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"delete": {
"operationId": "users_destroy",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"responses": {
"204": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/hedgehog_config/": {
"get": {
"operationId": "users_hedgehog_config_retrieve",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
},
"patch": {
"operationId": "users_hedgehog_config_partial_update",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/scene_personalisation/": {
"post": {
"operationId": "users_scene_personalisation_create",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/start_2fa_setup/": {
"get": {
"operationId": "users_start_2fa_setup_retrieve",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/two_factor_backup_codes/": {
"post": {
"operationId": "users_two_factor_backup_codes_create",
"description": "Generate new backup codes, invalidating any existing ones",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/two_factor_disable/": {
"post": {
"operationId": "users_two_factor_disable_create",
"description": "Disable 2FA and remove all related devices",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/two_factor_start_setup/": {
"get": {
"operationId": "users_two_factor_start_setup_retrieve",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/two_factor_status/": {
"get": {
"operationId": "users_two_factor_status_retrieve",
"description": "Get current 2FA status including backup codes if enabled",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/two_factor_validate/": {
"post": {
"operationId": "users_two_factor_validate_create",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/{uuid}/validate_2fa/": {
"post": {
"operationId": "users_validate_2fa_create",
"parameters": [
{
"in": "path",
"name": "uuid",
"schema": {
"type": "string",
"format": "uuid"
},
"required": true
}
],
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/cancel_email_change_request/": {
"patch": {
"operationId": "users_cancel_email_change_request_partial_update",
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUser"
}
}
}
},
"security": [
{
"PersonalAPIKeyAuth": null
}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/request_email_verification/": {
"post": {
"operationId": "users_request_email_verification_create",
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
},
"/api/users/verify_email/": {
"post": {
"operationId": "users_verify_email_create",
"tags": [
"users",
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/User"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"required": true
},
"security": [
{}
],
"responses": {
"200": {
"description": "No response body"
}
}
}
}
},
"components": {
"schemas": {
"Action": {
"type": "object",
"description": "Serializer mixin that resolves appropriate response for tags depending on license.",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"nullable": true,
"maxLength": 400
},
"description": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"post_to_slack": {
"type": "boolean"
},
"slack_message_format": {
"type": "string",
"maxLength": 1200
},
"steps": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActionStepJSON"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"created_by": {
"allOf": [
{
"$ref": "#/components/schemas/UserBasic"
}
],
"readOnly": true
},
"deleted": {
"type": "boolean"
},
"is_calculating": {
"type": "boolean",
"readOnly": true
},
"last_calculated_at": {
"type": "string",
"format": "date-time"
},
"team_id": {
"type": "integer",
"readOnly": true
},
"is_action": {
"type": "boolean",
"readOnly": true,
"default": true
},
"bytecode_error": {
"type": "string",
"readOnly": true,
"nullable": true
},
"pinned_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"creation_context": {
"type": "string",
"readOnly": true
},
"_create_in_folder": {
"type": "string",
"writeOnly": true,
"title": " create in folder"
}
},
"required": [
"bytecode_error",
"created_at",
"created_by",
"creation_context",
"id",
"is_action",
"is_calculating",
"team_id"
]
},
"ActionConversionGoal": {
"additionalProperties": false,
"properties": {
"actionId": {
"title": "Actionid",
"type": "integer"
}
},
"required": [
"actionId"
],
"title": "ActionConversionGoal",
"type": "object"
},
"ActionStepJSON": {
"type": "object",
"properties": {
"event": {
"type": "string",
"nullable": true
},
"properties": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"nullable": true
},
"selector": {
"type": "string",
"nullable": true
},
"tag_name": {
"type": "string",
"nullable": true
},
"text": {
"type": "string",
"nullable": true
},
"text_matching": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/UrlMatchingEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"href": {
"type": "string",
"nullable": true
},
"href_matching": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/UrlMatchingEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"url": {
"type": "string",
"nullable": true
},
"url_matching": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/UrlMatchingEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
}
}
},
"ActionsNode": {
"additionalProperties": false,
"properties": {
"custom_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Custom Name"
},
"fixedProperties": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/EventMetadataPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingPropertyFilter"
},
{
"$ref": "#/components/schemas/LogEntryPropertyFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ErrorTrackingIssueFilter"
},
{
"$ref": "#/components/schemas/LogPropertyFilter"
},
{
"$ref": "#/components/schemas/RevenueAnalyticsPropertyFilter"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Fixed properties in the query, can't be edited in the interface (e.g. scoping down by person)",
"title": "Fixedproperties"
},
"id": {
"title": "Id",
"type": "integer"
},
"kind": {
"const": "ActionsNode",
"default": "ActionsNode",
"title": "Kind",
"type": "string"
},
"math": {
"anyOf": [
{
"$ref": "#/components/schemas/BaseMathType"
},
{
"$ref": "#/components/schemas/FunnelMathType"
},
{
"$ref": "#/components/schemas/PropertyMathType"
},
{
"$ref": "#/components/schemas/CountPerActorMathType"
},
{
"$ref": "#/components/schemas/ExperimentMetricMathType"
},
{
"$ref": "#/components/schemas/CalendarHeatmapMathType"
},
{
"const": "unique_group",
"type": "string"
},
{
"const": "hogql",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math"
},
"math_group_type_index": {
"anyOf": [
{
"$ref": "#/components/schemas/MathGroupTypeIndex"
},
{
"type": "null"
}
],
"default": null
},
"math_hogql": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Hogql"
},
"math_property": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Property"
},
"math_property_revenue_currency": {
"anyOf": [
{
"$ref": "#/components/schemas/RevenueCurrencyPropertyConfig"
},
{
"type": "null"
}
],
"default": null
},
"math_property_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Math Property Type"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"properties": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/EventPropertyFilter"
},
{
"$ref": "#/components/schemas/PersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ElementPropertyFilter"
},
{
"$ref": "#/components/schemas/EventMetadataPropertyFilter"
},
{
"$ref": "#/components/schemas/SessionPropertyFilter"
},
{
"$ref": "#/components/schemas/CohortPropertyFilter"
},
{
"$ref": "#/components/schemas/RecordingPropertyFilter"
},
{
"$ref": "#/components/schemas/LogEntryPropertyFilter"
},
{
"$ref": "#/components/schemas/GroupPropertyFilter"
},
{
"$ref": "#/components/schemas/FeaturePropertyFilter"
},
{
"$ref": "#/components/schemas/HogQLPropertyFilter"
},
{
"$ref": "#/components/schemas/EmptyPropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePropertyFilter"
},
{
"$ref": "#/components/schemas/DataWarehousePersonPropertyFilter"
},
{
"$ref": "#/components/schemas/ErrorTrackingIssueFilter"
},
{
"$ref": "#/components/schemas/LogPropertyFilter"
},
{
"$ref": "#/components/schemas/RevenueAnalyticsPropertyFilter"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Properties configurable in the interface",
"title": "Properties"
},
"response": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Response"
}
},
"required": [
"id"
],
"title": "ActionsNode",
"type": "object"
},
"ActionsPie": {
"additionalProperties": false,
"properties": {
"disableHoverOffset": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Disablehoveroffset"
},
"hideAggregation": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Hideaggregation"
}
},
"title": "ActionsPie",
"type": "object"
},
"ActivityLog": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"readOnly": true
},
"user": {
"$ref": "#/components/schemas/UserBasic"
},
"unread": {
"type": "boolean",
"description": "is the date of this log item newer than the user's bookmark",
"readOnly": true
},
"organization_id": {
"type": "string",
"format": "uuid",
"nullable": true
},
"was_impersonated": {
"type": "boolean",
"nullable": true
},
"is_system": {
"type": "boolean",
"nullable": true
},
"activity": {
"type": "string",
"maxLength": 79
},
"item_id": {
"type": "string",
"nullable": true,
"maxLength": 72
},
"scope": {
"type": "string",
"maxLength": 79
},
"detail": {
"nullable": true
},
"created_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"activity",
"id",
"scope",
"unread",
"user"
]
},
"ActorsPropertyTaxonomyQuery": {
"additionalProperties": false,
"properties": {
"group_type_index": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Group Type Index"
},
"kind": {
"const": "ActorsPropertyTaxonomyQuery",
"default": "ActorsPropertyTaxonomyQuery",
"title": "Kind",
"type": "string"
},
"maxPropertyValues": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Maxpropertyvalues"
},
"modifiers": {
"anyOf": [
{
"$ref": "#/components/schemas/HogQLQueryModifiers"
},
{
"type": "null"
}
],
"default": null,
"description": "Modifiers used when performing the query"
},
"property": {
"title": "Property",
"type": "string"
},
"response": {
"anyOf": [
{
"$ref": "#/components/schemas/ActorsPropertyTaxonomyQueryResponse"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"property"
],
"title": "ActorsPropertyTaxonomyQuery",
"type": "object"
},
"ActorsPropertyTaxonomyQueryResponse": {
"additionalProperties": false,
"properties": {
"error": {
"anyOf": [
{
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment