PostHog

PostHog core API

The core API from PostHog — 182 operation(s) for core.

GitHub OpenAPI

Operations 263

Showing the first 250 of 263. The full set is in the contract, and via get_provider_operations.

GET /api/environments/{environment_id}/dashboards/ #
POST /api/environments/{environment_id}/dashboards/ #
GET /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/ #
POST /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/ #
DELETE /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/ #
POST /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/ #
GET /api/environments/{environment_id}/dashboards/{id}/ #
PUT /api/environments/{environment_id}/dashboards/{id}/ #
PATCH /api/environments/{environment_id}/dashboards/{id}/ #
DELETE /api/environments/{environment_id}/dashboards/{id}/ #
POST /api/environments/{environment_id}/dashboards/{id}/analyze_refresh_result/ #
POST /api/environments/{environment_id}/dashboards/{id}/copy_tile/ #
PATCH /api/environments/{environment_id}/dashboards/{id}/move_tile/ #
POST /api/environments/{environment_id}/dashboards/{id}/reorder_tiles/ #
GET /api/environments/{environment_id}/dashboards/{id}/run_insights/ #
POST /api/environments/{environment_id}/dashboards/{id}/snapshot/ #
GET /api/environments/{environment_id}/dashboards/{id}/stream_tiles/ #
POST /api/environments/{environment_id}/dashboards/bulk_update_tags/ #
POST /api/environments/{environment_id}/dashboards/create_from_template_json/ #
POST /api/environments/{environment_id}/dashboards/create_unlisted_dashboard/ #
GET /api/environments/{environment_id}/exports/ #
POST /api/environments/{environment_id}/exports/ #
GET /api/environments/{environment_id}/exports/{id}/ #
GET /api/environments/{environment_id}/exports/{id}/content/ #
GET /api/environments/{environment_id}/file_system/ #
POST /api/environments/{environment_id}/file_system/ #
GET /api/environments/{environment_id}/file_system/{id}/ #
PUT /api/environments/{environment_id}/file_system/{id}/ #
PATCH /api/environments/{environment_id}/file_system/{id}/ #
DELETE /api/environments/{environment_id}/file_system/{id}/ #
POST /api/environments/{environment_id}/file_system/{id}/count/ #
POST /api/environments/{environment_id}/file_system/{id}/move/ #
POST /api/environments/{environment_id}/file_system/count_by_path/ #
GET /api/environments/{environment_id}/file_system/log_view/ #
POST /api/environments/{environment_id}/file_system/log_view/ #
POST /api/environments/{environment_id}/file_system/undo_delete/ #
GET /api/environments/{environment_id}/file_system/unfiled/ #
GET /api/environments/{environment_id}/groups/ #
POST /api/environments/{environment_id}/groups/ #
GET /api/environments/{environment_id}/groups/activity/ #
POST /api/environments/{environment_id}/groups/delete_property/ #
GET /api/environments/{environment_id}/groups/find/ #
GET /api/environments/{environment_id}/groups/property_definitions/ #
GET /api/environments/{environment_id}/groups/property_values/ #
POST /api/environments/{environment_id}/groups/update_property/ #
GET /api/environments/{environment_id}/insights/{insight_id}/sharing/ #
POST /api/environments/{environment_id}/insights/{insight_id}/sharing/passwords/ #
DELETE /api/environments/{environment_id}/insights/{insight_id}/sharing/passwords/{password_id}/ #
POST /api/environments/{environment_id}/insights/{insight_id}/sharing/refresh/ #
GET /api/environments/{environment_id}/project_secret_api_keys/ #
POST /api/environments/{environment_id}/project_secret_api_keys/ #
GET /api/environments/{environment_id}/project_secret_api_keys/{id}/ #
PUT /api/environments/{environment_id}/project_secret_api_keys/{id}/ #
PATCH /api/environments/{environment_id}/project_secret_api_keys/{id}/ #
DELETE /api/environments/{environment_id}/project_secret_api_keys/{id}/ #
POST /api/environments/{environment_id}/project_secret_api_keys/{id}/roll/ #
GET /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/ #
POST /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/passwords/ #
DELETE /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/passwords/{password_id}/ #
POST /api/environments/{environment_id}/session_recordings/{recording_id}/sharing/refresh/ #
GET /api/environments/{environment_id}/subscriptions/ #
POST /api/environments/{environment_id}/subscriptions/ #
GET /api/environments/{environment_id}/subscriptions/{id}/ #
PUT /api/environments/{environment_id}/subscriptions/{id}/ #
PATCH /api/environments/{environment_id}/subscriptions/{id}/ #
DELETE /api/environments/{environment_id}/subscriptions/{id}/ #
POST /api/environments/{environment_id}/subscriptions/{id}/test-delivery/ #
GET /api/environments/{project_id}/subscriptions/{subscription_id}/deliveries/ List subscription deliveries #
GET /api/environments/{project_id}/subscriptions/{subscription_id}/deliveries/{id}/ Retrieve subscription delivery #
GET /api/organizations/{organization_id}/domains/ #
POST /api/organizations/{organization_id}/domains/ #
GET /api/organizations/{organization_id}/domains/{id}/ #
PUT /api/organizations/{organization_id}/domains/{id}/ #
PATCH /api/organizations/{organization_id}/domains/{id}/ #
DELETE /api/organizations/{organization_id}/domains/{id}/ #
GET /api/organizations/{organization_id}/domains/{id}/scim/logs/ #
POST /api/organizations/{organization_id}/domains/{id}/scim/token/ #
POST /api/organizations/{organization_id}/domains/{id}/verify/ #
GET /api/organizations/{organization_id}/invites/ #
POST /api/organizations/{organization_id}/invites/ #
DELETE /api/organizations/{organization_id}/invites/{id}/ #
POST /api/organizations/{organization_id}/invites/bulk/ #
GET /api/organizations/{organization_id}/members/ #
PUT /api/organizations/{organization_id}/members/{user__uuid}/ #
PATCH /api/organizations/{organization_id}/members/{user__uuid}/ #
DELETE /api/organizations/{organization_id}/members/{user__uuid}/ #
GET /api/organizations/{organization_id}/members/{user__uuid}/scoped_api_keys/ #
GET /api/organizations/{organization_id}/oauth_applications/ #
GET /api/organizations/{organization_id}/projects/ #
POST /api/organizations/{organization_id}/projects/ #
GET /api/organizations/{organization_id}/projects/{id}/ #
PUT /api/organizations/{organization_id}/projects/{id}/ #
PATCH /api/organizations/{organization_id}/projects/{id}/ #
DELETE /api/organizations/{organization_id}/projects/{id}/ #
GET /api/organizations/{organization_id}/projects/{id}/activity/ #
PATCH /api/organizations/{organization_id}/projects/{id}/add_product_intent/ #
POST /api/organizations/{organization_id}/projects/{id}/change_organization/ #
PATCH /api/organizations/{organization_id}/projects/{id}/complete_product_onboarding/ #
PATCH /api/organizations/{organization_id}/projects/{id}/delete_secret_token_backup/ #
POST /api/organizations/{organization_id}/projects/{id}/generate_conversations_public_token/ #
GET /api/organizations/{organization_id}/projects/{id}/is_generating_demo_data/ #
PATCH /api/organizations/{organization_id}/projects/{id}/reset_token/ #
PATCH /api/organizations/{organization_id}/projects/{id}/rotate_secret_token/ #
GET /api/organizations/{organization_id}/roles/ #
POST /api/organizations/{organization_id}/roles/ #
GET /api/organizations/{organization_id}/roles/{id}/ #
PUT /api/organizations/{organization_id}/roles/{id}/ #
PATCH /api/organizations/{organization_id}/roles/{id}/ #
DELETE /api/organizations/{organization_id}/roles/{id}/ #
GET /api/projects/{project_id}/annotations/ #
POST /api/projects/{project_id}/annotations/ #
GET /api/projects/{project_id}/annotations/{id}/ #
PUT /api/projects/{project_id}/annotations/{id}/ #
PATCH /api/projects/{project_id}/annotations/{id}/ #
DELETE /api/projects/{project_id}/annotations/{id}/ #
GET /api/projects/{project_id}/cohorts/ #
POST /api/projects/{project_id}/cohorts/ #
GET /api/projects/{project_id}/cohorts/{id}/ #
PUT /api/projects/{project_id}/cohorts/{id}/ #
PATCH /api/projects/{project_id}/cohorts/{id}/ #
DELETE /api/projects/{project_id}/cohorts/{id}/ #
GET /api/projects/{project_id}/cohorts/{id}/activity/ #
PATCH /api/projects/{project_id}/cohorts/{id}/add_persons_to_static_cohort/ #
GET /api/projects/{project_id}/cohorts/{id}/calculation_history/ #
GET /api/projects/{project_id}/cohorts/{id}/persons/ #
PATCH /api/projects/{project_id}/cohorts/{id}/remove_person_from_static_cohort/ #
GET /api/projects/{project_id}/cohorts/activity/ #
GET /api/projects/{project_id}/comments/ #
POST /api/projects/{project_id}/comments/ #
GET /api/projects/{project_id}/comments/{id}/ #
PUT /api/projects/{project_id}/comments/{id}/ #
PATCH /api/projects/{project_id}/comments/{id}/ #
DELETE /api/projects/{project_id}/comments/{id}/ #
GET /api/projects/{project_id}/comments/{id}/thread/ #
GET /api/projects/{project_id}/comments/count/ #
GET /api/projects/{project_id}/dashboard_templates/ #
POST /api/projects/{project_id}/dashboard_templates/ #
GET /api/projects/{project_id}/dashboard_templates/{id}/ #
PUT /api/projects/{project_id}/dashboard_templates/{id}/ #
PATCH /api/projects/{project_id}/dashboard_templates/{id}/ #
DELETE /api/projects/{project_id}/dashboard_templates/{id}/ #
POST /api/projects/{project_id}/dashboard_templates/copy_between_projects/ Copy a team template to this project #
GET /api/projects/{project_id}/dashboard_templates/json_schema/ #
GET /api/projects/{project_id}/dashboards/ #
POST /api/projects/{project_id}/dashboards/ #
GET /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/ #
POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/ #
DELETE /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/ #
POST /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/refresh/ #
GET /api/projects/{project_id}/dashboards/{id}/ #
PUT /api/projects/{project_id}/dashboards/{id}/ #
PATCH /api/projects/{project_id}/dashboards/{id}/ #
DELETE /api/projects/{project_id}/dashboards/{id}/ #
POST /api/projects/{project_id}/dashboards/{id}/analyze_refresh_result/ #
POST /api/projects/{project_id}/dashboards/{id}/copy_tile/ #
PATCH /api/projects/{project_id}/dashboards/{id}/move_tile/ #
POST /api/projects/{project_id}/dashboards/{id}/reorder_tiles/ #
GET /api/projects/{project_id}/dashboards/{id}/run_insights/ #
POST /api/projects/{project_id}/dashboards/{id}/snapshot/ #
GET /api/projects/{project_id}/dashboards/{id}/stream_tiles/ #
POST /api/projects/{project_id}/dashboards/bulk_update_tags/ #
POST /api/projects/{project_id}/dashboards/create_from_template_json/ #
POST /api/projects/{project_id}/dashboards/create_unlisted_dashboard/ #
GET /api/projects/{project_id}/event_definitions/ #
POST /api/projects/{project_id}/event_definitions/ #
GET /api/projects/{project_id}/event_definitions/{id}/ #
PUT /api/projects/{project_id}/event_definitions/{id}/ #
PATCH /api/projects/{project_id}/event_definitions/{id}/ #
DELETE /api/projects/{project_id}/event_definitions/{id}/ #
GET /api/projects/{project_id}/event_definitions/{id}/metrics/ #
POST /api/projects/{project_id}/event_definitions/bulk_update_tags/ #
GET /api/projects/{project_id}/event_definitions/by_name/ #
GET /api/projects/{project_id}/event_definitions/golang/ #
GET /api/projects/{project_id}/event_definitions/promoted_properties/ #
GET /api/projects/{project_id}/event_definitions/python/ #
GET /api/projects/{project_id}/event_definitions/typescript/ #
GET /api/projects/{project_id}/exports/ #
POST /api/projects/{project_id}/exports/ #
GET /api/projects/{project_id}/exports/{id}/ #
GET /api/projects/{project_id}/exports/{id}/content/ #
GET /api/projects/{project_id}/file_system/ #
POST /api/projects/{project_id}/file_system/ #
GET /api/projects/{project_id}/file_system/{id}/ #
PUT /api/projects/{project_id}/file_system/{id}/ #
PATCH /api/projects/{project_id}/file_system/{id}/ #
DELETE /api/projects/{project_id}/file_system/{id}/ #
POST /api/projects/{project_id}/file_system/{id}/count/ #
POST /api/projects/{project_id}/file_system/{id}/move/ #
POST /api/projects/{project_id}/file_system/count_by_path/ #
GET /api/projects/{project_id}/file_system/log_view/ #
POST /api/projects/{project_id}/file_system/log_view/ #
POST /api/projects/{project_id}/file_system/undo_delete/ #
GET /api/projects/{project_id}/file_system/unfiled/ #
GET /api/projects/{project_id}/groups/ #
POST /api/projects/{project_id}/groups/ #
GET /api/projects/{project_id}/groups/activity/ #
POST /api/projects/{project_id}/groups/delete_property/ #
GET /api/projects/{project_id}/groups/find/ #
GET /api/projects/{project_id}/groups/property_definitions/ #
GET /api/projects/{project_id}/groups/property_values/ #
POST /api/projects/{project_id}/groups/update_property/ #
GET /api/projects/{project_id}/insights/{insight_id}/sharing/ #
POST /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/ #
DELETE /api/projects/{project_id}/insights/{insight_id}/sharing/passwords/{password_id}/ #
POST /api/projects/{project_id}/insights/{insight_id}/sharing/refresh/ #
GET /api/projects/{project_id}/project_secret_api_keys/ #
POST /api/projects/{project_id}/project_secret_api_keys/ #
GET /api/projects/{project_id}/project_secret_api_keys/{id}/ #
PUT /api/projects/{project_id}/project_secret_api_keys/{id}/ #
PATCH /api/projects/{project_id}/project_secret_api_keys/{id}/ #
DELETE /api/projects/{project_id}/project_secret_api_keys/{id}/ #
POST /api/projects/{project_id}/project_secret_api_keys/{id}/roll/ #
GET /api/projects/{project_id}/property_definitions/ #
GET /api/projects/{project_id}/property_definitions/{id}/ #
PUT /api/projects/{project_id}/property_definitions/{id}/ #
PATCH /api/projects/{project_id}/property_definitions/{id}/ #
DELETE /api/projects/{project_id}/property_definitions/{id}/ #
POST /api/projects/{project_id}/property_definitions/bulk_update_tags/ #
GET /api/projects/{project_id}/property_definitions/seen_together/ #
GET /api/projects/{project_id}/session_recordings/{recording_id}/sharing/ #
POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/ #
DELETE /api/projects/{project_id}/session_recordings/{recording_id}/sharing/passwords/{password_id}/ #
POST /api/projects/{project_id}/session_recordings/{recording_id}/sharing/refresh/ #
GET /api/projects/{project_id}/subscriptions/ #
POST /api/projects/{project_id}/subscriptions/ #
GET /api/projects/{project_id}/subscriptions/{id}/ #
PUT /api/projects/{project_id}/subscriptions/{id}/ #
PATCH /api/projects/{project_id}/subscriptions/{id}/ #
DELETE /api/projects/{project_id}/subscriptions/{id}/ #
POST /api/projects/{project_id}/subscriptions/{id}/test-delivery/ #
GET /api/users/ #
GET /api/users/{uuid}/ #
PUT /api/users/{uuid}/ #
PATCH /api/users/{uuid}/ #
DELETE /api/users/{uuid}/ #
GET /api/users/{uuid}/github_login/ #
GET /api/users/{uuid}/hedgehog_config/ #
PATCH /api/users/{uuid}/hedgehog_config/ #
GET /api/users/{uuid}/integrations/ List personal GitHub integrations #
DELETE /api/users/{uuid}/integrations/github/{installation_id}/ Disconnect a personal GitHub integration #
GET /api/users/{uuid}/integrations/github/{installation_id}/branches/ List branches for a personal GitHub installation repository #
GET /api/users/{uuid}/integrations/github/{installation_id}/repos/ List repositories for a personal GitHub installation #

Documentation

📖
Documentation
https://posthog.com/docs/api
📖
GettingStarted
https://posthog.com/docs/api
📖
Authentication
https://posthog.com/docs/api#authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/openapi/posthog-core-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/asyncapi/posthog-webhooks-asyncapi.yml

Other Resources

🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/graphql/posthog-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/posthog-core-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

posthog-core-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PostHog actions Core API
  version: 1.0.0
  description: ''
servers:
- url: https://app.posthog.com/api
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: core
paths:
  /api/environments/{environment_id}/dashboards/:
    get:
      operationId: environments_dashboards_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - 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:
      - core
      security:
      - PersonalAPIKeyAuth:
        - dashboard:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDashboardBasicList'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/PaginatedDashboardBasicList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
      - dashboards
    post:
      operationId: environments_dashboards_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      tags:
      - core
      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'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
      - dashboards
  /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/:
    get:
      operationId: environments_dashboards_sharing_list
      parameters:
      - in: path
        name: dashboard_id
        schema:
          type: integer
        required: true
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - sharing_configuration:read
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SharingConfiguration'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/:
    post:
      operationId: environments_dashboards_sharing_passwords_create
      description: Create a new password for the sharing configuration.
      parameters:
      - in: path
        name: dashboard_id
        schema:
          type: integer
        required: true
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
      security:
      - PersonalAPIKeyAuth:
        - sharing_configuration:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingConfiguration'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/:
    delete:
      operationId: environments_dashboards_sharing_passwords_destroy
      description: Delete a password from the sharing configuration.
      parameters:
      - in: path
        name: dashboard_id
        schema:
          type: integer
        required: true
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: password_id
        schema:
          type: string
        required: true
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - sharing_configuration:write
      responses:
        '204':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/:
    post:
      operationId: environments_dashboards_sharing_refresh_create
      parameters:
      - in: path
        name: dashboard_id
        schema:
          type: integer
        required: true
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SharingConfiguration'
      security:
      - PersonalAPIKeyAuth:
        - sharing_configuration:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingConfiguration'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/:
    get:
      operationId: environments_dashboards_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: filters_override
        schema:
          type: string
        description: JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token.
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      - in: query
        name: variables_override
        schema:
          type: string
        description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>": {"code_name": "<code_name>", "variableId": "<variable_id>", "value": <new_value>}}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response''s `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token.'
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - dashboard:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    put:
      operationId: environments_dashboards_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      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'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    patch:
      operationId: environments_dashboards_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      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'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    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:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - dashboard:write
      responses:
        '405':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/analyze_refresh_result/:
    post:
      operationId: environments_dashboards_analyze_refresh_result_create
      description: 'Generate AI analysis comparing before/after dashboard refresh.

        Expects cache_key in request body pointing to the stored ''before'' state.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      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'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/copy_tile/:
    post:
      operationId: environments_dashboards_copy_tile_create
      description: Copy an existing dashboard tile to another dashboard (insight or text card; new tile row).
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CopyDashboardTileRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CopyDashboardTileRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CopyDashboardTileRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - dashboard:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/move_tile/:
    patch:
      operationId: environments_dashboards_move_tile_partial_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      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'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/reorder_tiles/:
    post:
      operationId: environments_dashboards_reorder_tiles_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReorderTilesRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ReorderTilesRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ReorderTilesRequest'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - dashboard:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/run_insights/:
    get:
      operationId: environments_dashboards_run_insights_retrieve
      description: Run all insights on a dashboard and return their results.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: filters_override
        schema:
          type: string
        description: JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token.
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      - in: query
        name: output_format
        schema:
          type: string
          enum:
          - json
          - optimized
        description: '''optimized'' (default) returns LLM-friendly formatted text per insight. ''json'' returns the raw query result objects.'
      - in: query
        name: refresh
        schema:
          type: string
          enum:
          - blocking
          - force_blocking
          - force_cache
        description: Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh, otherwise recalculates. 'force_blocking' always recalculates.
      - in: query
        name: variables_override
        schema:
          type: string
        description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>": {"code_name": "<code_name>", "variableId": "<variable_id>", "value": <new_value>}}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response''s `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token.'
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - query:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunInsightsResponse'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/RunInsightsResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/snapshot/:
    post:
      operationId: environments_dashboards_snapshot_create
      description: 'Snapshot the current dashboard state (from cache) for AI analysis.

        Returns a cache_key representing the ''before'' state, to be used with analyze_refresh_result.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      tags:
      - core
      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'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/{id}/stream_tiles/:
    get:
      operationId: environments_dashboards_stream_tiles_retrieve
      description: Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: filters_override
        schema:
          type: string
        description: JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token.
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard.
        required: true
      - in: query
        name: layoutSize
        schema:
          type: string
          enum:
          - sm
          - xs
        description: Layout size for tile positioning. 'sm' (default) for standard, 'xs' for mobile. The snake_case alias `layout_size` is also accepted for backward compatibility.
      - in: query
        name: variables_override
        schema:
          type: string
        description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>": {"code_name": "<code_name>", "variableId": "<variable_id>", "value": <new_value>}}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response''s `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token.'
      tags:
      - core
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/dashboards/bulk_update_tags/:
    post:
      operationId: environments_dashboards_bulk_update_tags_create
      description: 'Bulk update tags on multiple objects.


        Accepts:

        - {"ids": [...], "action": "add"|"remove"|"set", "tags": ["tag1", "tag2"]}


        Actions:

        - "add": Add tags to existing tags on each object

        - "remove": Remove specific tags from each object

        - "set": Replace all tags on each object with the provided list'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateTagsRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BulkUpdateTagsRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BulkUpdateTagsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpdateTagsResponse'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/BulkUpdateTagsResponse'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
      - dashboards
  /api/environments/{environment_id}/dashboards/create_from_template_json/:
    post:
      operationId: environments_dashboards_create_from_template_json_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
      - dashboards
  /api/environments/{environment_id}/dashboards/create_unlisted_dashboard/:
    post:
      operationId: environments_dashboards_create_unlisted_dashboard_create
      description: 'Creates an unlisted dashboard from template by tag.

        Enforces uniqueness (one per tag per team).

        Returns 409 if unlisted dashboard with this tag already exists.'
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: query
        name: format
        schema:
          type: string
          enum:
          - json
          - txt
      tags:
      - core
      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'
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
      - dashboards
  /api/environments/{environment_id}/exports/:
    get:
      operationId: environments_exports_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - 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:
      - core
      security:
      - PersonalAPIKeyAuth:
        - export:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedExportedAssetList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    post:
      operationId: environments_exports_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - core
      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: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/exports/{id}/:
    get:
      operationId: environments_exports_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exported asset.
        required: true
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - export:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportedAsset'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/exports/{id}/content/:
    get:
      operationId: environments_exports_content_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this exported asset.
        required: true
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - export:read
      responses:
        '200':
          description: No response body
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/file_system/:
    get:
      operationId: environments_file_system_list
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - 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
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - file_system:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFileSystemList'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    post:
      operationId: environments_file_system_create
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileSystem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FileSystem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileSystem'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - file_system:write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystem'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
  /api/environments/{environment_id}/file_system/{id}/:
    get:
      operationId: environments_file_system_retrieve
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file system.
        required: true
      tags:
      - core
      security:
      - PersonalAPIKeyAuth:
        - file_system:read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSystem'
          description: ''
      deprecated: true
      x-explicit-tags:
      - core
    put:
      operationId: environments_file_system_update
      parameters:
      - $ref: '#/components/parameters/EnvironmentIdPath'
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this file system.
        required: true
      tags:
      - core
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileSystem'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/FileSystem'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/FileSystem'
        required: true
      security:
      - PersonalAPIKeyAuth:
        - file_system:write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileSyste

# --- truncated at 32 KB (487 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/openapi/posthog-core-api-openapi.yml