PostHog API — dashboards

naftiko: 1.0.0-alpha2
info:
  label: PostHog API — dashboards
  description: 'PostHog API — dashboards. 58 operations. Lead operation: dashboards. Self-contained Naftiko capability covering
    one Posthog business surface.'
  tags:
  - Posthog
  - dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTHOG_API_KEY: POSTHOG_API_KEY
capability:
  consumes:
  - type: http
    namespace: posthog-dashboards
    baseUri: ''
    description: PostHog API — dashboards business capability. Self-contained, no shared references.
    resources:
    - name: api-environments-environment_id-dashboards
      path: /api/environments/{environment_id}/dashboards/
      operations:
      - name: environmentsdashboardslist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: environmentsdashboardscreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-bulk_update_tags
      path: /api/environments/{environment_id}/dashboards/bulk_update_tags/
      operations:
      - name: environmentsdashboardsbulkupdatetagscreate
        method: POST
        description: Bulk update tags on multiple objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-dashboards-create_from_template_json
      path: /api/environments/{environment_id}/dashboards/create_from_template_json/
      operations:
      - name: environmentsdashboardscreatefromtemplatejsoncreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-create_unlisted_dashboard
      path: /api/environments/{environment_id}/dashboards/create_unlisted_dashboard/
      operations:
      - name: environmentsdashboardscreateunlisteddashboardcreate
        method: POST
        description: Creates an unlisted dashboard from template by tag.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-dashboard_id-collaborators
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/
      operations:
      - name: environmentsdashboardscollaboratorslist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
      - name: environmentsdashboardscollaboratorscreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-dashboards-dashboard_id-collaborators-user__uuid
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/
      operations:
      - name: environmentsdashboardscollaboratorsdestroy
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: user__uuid
          in: path
          type: string
          required: true
    - name: api-environments-environment_id-dashboards-dashboard_id-sharing
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/
      operations:
      - name: environmentsdashboardssharinglist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
    - name: api-environments-environment_id-dashboards-dashboard_id-sharing-passwords
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/
      operations:
      - name: environmentsdashboardssharingpasswordscreate
        method: POST
        description: Create a new password for the sharing configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-dashboard_id-sharing-passwords-passwo
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/
      operations:
      - name: environmentsdashboardssharingpasswordsdestroy
        method: DELETE
        description: Delete a password from the sharing configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: password_id
          in: path
          type: string
          required: true
    - name: api-environments-environment_id-dashboards-dashboard_id-sharing-refresh
      path: /api/environments/{environment_id}/dashboards/{dashboard_id}/sharing/refresh/
      operations:
      - name: environmentsdashboardssharingrefreshcreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-id
      path: /api/environments/{environment_id}/dashboards/{id}/
      operations:
      - name: environmentsdashboardsretrieve
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters_override
          in: query
          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 v
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: variables_override
          in: query
          type: string
          description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>":
            {"code_name": "<code_name>", "variableId": "<variab'
      - name: environmentsdashboardsupdate
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsdashboardspartialupdate
        method: PATCH
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsdashboardsdestroy
        method: DELETE
        description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
    - name: api-environments-environment_id-dashboards-id-analyze_refresh_result
      path: /api/environments/{environment_id}/dashboards/{id}/analyze_refresh_result/
      operations:
      - name: environmentsdashboardsanalyzerefreshresultcreate
        method: POST
        description: Generate AI analysis comparing before/after dashboard refresh.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-id-copy_tile
      path: /api/environments/{environment_id}/dashboards/{id}/copy_tile/
      operations:
      - name: environmentsdashboardscopytilecreate
        method: POST
        description: Copy an existing dashboard tile to another dashboard (insight or text card; new tile row).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-dashboards-id-move_tile
      path: /api/environments/{environment_id}/dashboards/{id}/move_tile/
      operations:
      - name: environmentsdashboardsmovetilepartialupdate
        method: PATCH
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-id-reorder_tiles
      path: /api/environments/{environment_id}/dashboards/{id}/reorder_tiles/
      operations:
      - name: environmentsdashboardsreordertilescreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-dashboards-id-run_insights
      path: /api/environments/{environment_id}/dashboards/{id}/run_insights/
      operations:
      - name: environmentsdashboardsruninsightsretrieve
        method: GET
        description: Run all insights on a dashboard and return their results.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters_override
          in: query
          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 v
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: output_format
          in: query
          type: string
          description: '''optimized'' (default) returns LLM-friendly formatted text per insight. ''json'' returns the raw
            query result objects.'
        - name: refresh
          in: query
          type: string
          description: Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh,
            otherwise recalculates. 'force_blocking' always recalcu
        - name: variables_override
          in: query
          type: string
          description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>":
            {"code_name": "<code_name>", "variableId": "<variab'
    - name: api-environments-environment_id-dashboards-id-snapshot
      path: /api/environments/{environment_id}/dashboards/{id}/snapshot/
      operations:
      - name: environmentsdashboardssnapshotcreate
        method: POST
        description: Snapshot the current dashboard state (from cache) for AI analysis.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-environments-environment_id-dashboards-id-stream_tiles
      path: /api/environments/{environment_id}/dashboards/{id}/stream_tiles/
      operations:
      - name: environmentsdashboardsstreamtilesretrieve
        method: GET
        description: Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they
          are rendered.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters_override
          in: query
          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 v
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: layoutSize
          in: query
          type: string
          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.
        - name: variables_override
          in: query
          type: string
          description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>":
            {"code_name": "<code_name>", "variableId": "<variab'
    - name: api-environments-environment_id-data_color_themes
      path: /api/environments/{environment_id}/data_color_themes/
      operations:
      - name: environmentsdatacolorthemeslist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: environmentsdatacolorthemescreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-environments-environment_id-data_color_themes-id
      path: /api/environments/{environment_id}/data_color_themes/{id}/
      operations:
      - name: environmentsdatacolorthemesretrieve
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this data color theme.
          required: true
      - name: environmentsdatacolorthemesupdate
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this data color theme.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: environmentsdatacolorthemespartialupdate
        method: PATCH
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this data color theme.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: environmentsdatacolorthemesdestroy
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this data color theme.
          required: true
    - name: api-projects-project_id-dashboards
      path: /api/projects/{project_id}/dashboards/
      operations:
      - name: dashboardslist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: dashboardscreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-bulk_update_tags
      path: /api/projects/{project_id}/dashboards/bulk_update_tags/
      operations:
      - name: dashboardsbulkupdatetagscreate
        method: POST
        description: Bulk update tags on multiple objects.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-dashboards-create_from_template_json
      path: /api/projects/{project_id}/dashboards/create_from_template_json/
      operations:
      - name: dashboardscreatefromtemplatejsoncreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-create_unlisted_dashboard
      path: /api/projects/{project_id}/dashboards/create_unlisted_dashboard/
      operations:
      - name: dashboardscreateunlisteddashboardcreate
        method: POST
        description: Creates an unlisted dashboard from template by tag.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-dashboard_id-collaborators
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/
      operations:
      - name: dashboardscollaboratorslist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
      - name: dashboardscollaboratorscreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-dashboards-dashboard_id-collaborators-user__uuid
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/
      operations:
      - name: dashboardscollaboratorsdestroy
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: user__uuid
          in: path
          type: string
          required: true
    - name: api-projects-project_id-dashboards-dashboard_id-sharing
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/
      operations:
      - name: dashboardssharinglist
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
    - name: api-projects-project_id-dashboards-dashboard_id-sharing-passwords
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/
      operations:
      - name: dashboardssharingpasswordscreate
        method: POST
        description: Create a new password for the sharing configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-dashboard_id-sharing-passwords-password_id
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/passwords/{password_id}/
      operations:
      - name: dashboardssharingpasswordsdestroy
        method: DELETE
        description: Delete a password from the sharing configuration.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: password_id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-dashboards-dashboard_id-sharing-refresh
      path: /api/projects/{project_id}/dashboards/{dashboard_id}/sharing/refresh/
      operations:
      - name: dashboardssharingrefreshcreate
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboard_id
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-id
      path: /api/projects/{project_id}/dashboards/{id}/
      operations:
      - name: dashboardsretrieve
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filters_override
          in: query
          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 v
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: variables_override
          in: query
          type: string
          description: 'JSON object to override dashboard variables for this request only (not persisted). Format: {"<variable_id>":
            {"code_name": "<code_name>", "variableId": "<variab'
      - name: dashboardsupdate
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: dashboardspartialupdate
        method: PATCH
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: dashboardsdestroy
        method: DELETE
        description: Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
    - name: api-projects-project_id-dashboards-id-analyze_refresh_result
      path: /api/projects/{project_id}/dashboards/{id}/analyze_refresh_result/
      operations:
      - name: dashboardsanalyzerefreshresultcreate
        method: POST
        description: Generate AI analysis comparing before/after dashboard refresh.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identifying this dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-dashboards-id-copy_tile
      path: /api/projects/{project_id}/dashboards/{id}/copy_tile/
      operations:
      - name: dashboardscopytilecreate
        method: POST
        description: Copy an existing dashboard tile to another dashboard (insight or text card; new tile row).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: format
          in: query
          type: string
        - name: id
          in: path
          type: integer
          description: A unique integer value identi

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/capabilities/posthog-dashboards.yaml