Dashboards API Reference

Next page →

List all dashboards

Also available via the PostHog MCP server:
dashboards-get-all — Get all dashboards

Required API key scopes

dashboard:read

Query parameters

folder
string
format
string
One of: "json""txt"
limit
integer
offset
integer
search
string

Response

Example request

GET /api/projects/:project_id/dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dashboards/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "pinned": true,
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "last_accessed_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z",
      "folder": "string",
      "is_shared": true,
      "deleted": true,
      "creation_mode": "default",
      "tags": [
        null
      ],
      "restriction_level": 21,
      "effective_restriction_level": 21,
      "effective_privilege_level": 21,
      "user_access_level": "string",
      "access_control_version": "string",
      "last_refresh": "2019-08-24T14:15:22Z",
      "team_id": 0,
      "search_match_type": "exact"
    }
  ]
}

Create dashboards

Also available via the PostHog MCP server:
dashboard-create — Create dashboard

Required API key scopes

dashboard:write

Query parameters

format
string
One of: "json""txt"
include_dashboards
boolean

Request parameters

name
stringnull
description
string
pinned
boolean
last_accessed_at
stringnull
deleted
boolean
breakdown_colors
data_color_theme_id
integernull
tags
array
restriction_level
last_refresh
stringnull
quick_filter_ids
arraynull
use_template
string
use_dashboard
integernull
delete_insights
boolean
Default: false
_create_in_folder
string

Response

Example request

POST /api/projects/:project_id/dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

List all dashboards collaborators

Required API key scopes

dashboard:read

Path parameters

dashboard_id
integer

Example request

GET /api/projects/:project_id/dashboards/:dashboard_id/collaborators
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/collaborators/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dashboard_id": 0,
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "level": 21,
  "added_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
}

Create dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

dashboard_id
integer

Request parameters

level
user_uuid
string

Response

Example request

POST /api/projects/:project_id/dashboards/:dashboard_id/collaborators
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/collaborators/\
	-d level=undefined,\
	-d user_uuid="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"user_uuid": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "dashboard_id": 0,
  "user": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "level": 21,
  "added_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f"
}

Delete dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

dashboard_id
integer
user__uuid
string

Example request

DELETE /api/projects/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/collaborators/{user__uuid}/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>",,
		user__uuid="<the user  uuid>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve dashboards

Also available via the PostHog MCP server:
dashboard-get — Get dashboard

Required API key scopes

dashboard:read

Path parameters

id
integer

Query parameters

filters_override
string
format
string
One of: "json""txt"
include_dashboards
boolean
variables_override
string

Response

Example request

GET /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update dashboards

Also available via the PostHog MCP server:
dashboard-update — Update dashboard

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"
include_dashboards
boolean

Request parameters

name
stringnull
description
string
pinned
boolean
filters
breakdown_colors
data_color_theme_id
integernull
tags
array
restriction_level
quick_filter_ids
arraynull
tiles
array
use_template
string
use_dashboard
integernull
delete_insights
boolean
Default: false

Response

Example request

PATCH /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Delete dashboards

Also available via the PostHog MCP server:
dashboard-delete — Delete dashboard

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Example request

DELETE /api/projects/:project_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create dashboards copy tile

Copy an existing dashboard tile to another dashboard (insight, text card, or widget tile).

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

fromDashboardId
integer
tileId
integer

Response

Example request

POST /api/projects/:project_id/dashboards/:id/copy_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/copy_tile/\
	-d fromDashboardId="integer",\
	-d tileId="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/copy_tile/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"fromDashboardId": "integer",
		"tileId": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards create text tile

Add a markdown text tile to a dashboard.

Text tiles render as markdown blocks on the dashboard — useful as section headings, dividers, or annotations between insight tiles to give the dashboard structure.

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

body
string
layouts
color
stringnull

Response

Example request

POST /api/projects/:project_id/dashboards/:id/create_text_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/create_text_tile/\
	-d body="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/create_text_tile/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"body": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": 0,
  "insight": {
    "id": 0,
    "short_id": "string",
    "name": "string",
    "derived_name": "string",
    "query": {
      "embedded": null,
      "full": null,
      "hidePersonsModal": null,
      "hideTooltipOnScroll": null,
      "kind": "InsightVizNode",
      "showCorrelationTable": null,
      "showFilters": null,
      "showHeader": null,
      "showLastComputation": null,
      "showLastComputationRefresh": null,
      "showResults": null,
      "showTable": null,
      "source": {
        "aggregation_group_type_index": null,
        "breakdownFilter": null,
        "calendarHeatmapFilter": null,
        "compareFilter": null,
        "conversionGoal": null,
        "dataColorTheme": null,
        "dateRange": null,
        "filterTestAccounts": false,
        "interval": "day",
        "kind": "TrendsQuery",
        "modifiers": null,
        "properties": [],
        "response": null,
        "samplingFactor": null,
        "series": [
          {
            "custom_name": null,
            "event": null,
            "fixedProperties": null,
            "kind": "EventsNode",
            "limit": null,
            "math": null,
            "math_group_type_index": null,
            "math_hogql": null,
            "math_multiplier": null,
            "math_property": null,
            "math_property_revenue_currency": null,
            "math_property_type": null,
            "name": null,
            "optionalInFunnel": null,
            "orderBy": null,
            "properties": null,
            "response": null,
            "version": null
          }
        ],
        "tags": null,
        "trendsFilter": null,
        "version": null
      },
      "suppressSessionAnalysisWarning": null,
      "version": null,
      "vizSpecificOptions": null
    },
    "order": -2147483648,
    "deleted": true,
    "dashboards": [
      0
    ],
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_refresh": "2019-08-24T14:15:22Z",
    "cache_target_age": "2019-08-24T14:15:22Z",
    "next_allowed_client_refresh": "2019-08-24T14:15:22Z",
    "result": null,
    "hasMore": true,
    "columns": [
      "string"
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "description": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "tags": [
      null
    ],
    "favorited": true,
    "last_modified_at": "2019-08-24T14:15:22Z",
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "is_sample": true,
    "effective_restriction_level": 21,
    "effective_privilege_level": 21,
    "user_access_level": "string",
    "timezone": "string",
    "is_cached": true,
    "query_status": null,
    "hogql": "string",
    "types": [
      null
    ],
    "resolved_date_range": {
      "date_from": "2019-08-24T14:15:22Z",
      "date_to": "2019-08-24T14:15:22Z"
    },
    "_create_in_folder": "string",
    "alerts": [
      null
    ],
    "filter_override_context": {
      "dashboard": null,
      "tile": null,
      "overridden_dashboard": null
    },
    "last_viewed_at": "2019-08-24T14:15:22Z",
    "search_match_type": "exact"
  },
  "text": {
    "id": 0,
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "body": "string",
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "button_tile": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "url": "string",
    "text": "string",
    "placement": "left",
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "style": "primary",
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "widget": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "last_modified_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {},
      "role_at_organization": "engineering"
    },
    "widget_type": "string",
    "name": "string",
    "description": "string",
    "config": {
      "dateRange": null,
      "filterTestAccounts": null,
      "widgetFilters": null,
      "limit": 25,
      "eventName": null,
      "properties": null
    },
    "dashboard_tiles": [
      {
        "id": 0,
        "dashboard_id": 0,
        "deleted": true
      }
    ],
    "last_modified_at": "2019-08-24T14:15:22Z",
    "team": 0
  },
  "layouts": null,
  "color": "string",
  "filters_overrides": null,
  "show_description": true,
  "transparent_background": true
}

Create dashboards delete

Soft-delete a single tile from a dashboard.

Works for text, insight, and button tiles. The underlying Insight, Text, or ButtonTile object is preserved — only the dashboard tile is hidden. To delete the entire dashboard, use the dashboard delete endpoint instead.

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

tile_id
integer

Example request

POST /api/projects/:project_id/dashboards/:id/delete_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/delete_tile/\
	-d tile_id="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/delete_tile/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"tile_id": "integer"
	}
).json()

Example response

Status 204 No response body

Create dashboards move tile

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

to_dashboard
integer
tile

Response

Example request

POST /api/projects/:project_id/dashboards/:id/move_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/move_tile/\
	-d to_dashboard="integer",\
	-d tile=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/move_tile/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"to_dashboard": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update dashboards move tile

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

to_dashboard
integer
tile

Response

Example request

PATCH /api/projects/:project_id/dashboards/:id/move_tile
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/move_tile/\
	-d to_dashboard="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/move_tile/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"to_dashboard": "integer"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards reorder tiles

Required API key scopes

dashboard:write

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

Request parameters

tile_order
array
layout
Default: preserve

Response

Example request

POST /api/projects/:project_id/dashboards/:id/reorder_tiles
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/reorder_tiles/\
	-d tile_order="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/reorder_tiles/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"tile_order": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "description": "string",
  "pinned": true,
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "last_accessed_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z",
  "folder": "string",
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "filters": {},
  "variables": {},
  "breakdown_colors": null,
  "data_color_theme_id": 0,
  "tags": [
    null
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string",
  "last_refresh": "2019-08-24T14:15:22Z",
  "persisted_filters": {},
  "persisted_variables": {},
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {}
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Retrieve dashboards run insights

Run all insights on a dashboard and return their results.

Required API key scopes

query:read

Path parameters

id
integer

Query parameters

filters_override
string
format
string
One of: "json""txt"
output_format
string
One of: "json""optimized"
refresh
string
One of: "blocking""force_blocking""force_cache"
variables_override
string

Response

Example request

GET /api/projects/:project_id/dashboards/:id/run_insights
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/dashboards/:id/run_insights/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboard_id}/run_insights/".format(
        project_id=project_id,
		dashboard_id="<the dashboard id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": 0,
      "insight": {
        "id": 0,
        "short_id": "string",
        "name": "string",
        "derived_name": "string",
        "result": null
      }
    }
  ]
}

Next page →

`GET`
`POST`
`GET`
`POST`
`DELETE`
`GET`
`POST`
`DELETE`
`POST`
`GET`
`PATCH`
`DELETE`
`POST`
`POST`
`POST`
`POST`
`PATCH`
`POST`
`GET`

Dashboards

Endpoints

List all dashboards

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create dashboards

Required API key scopes

Query parameters

Request parameters

Response

Example request

Example response

Status 201

List all dashboards collaborators

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create dashboards collaborators

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Delete dashboards collaborators

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

List all dashboards sharing

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create dashboards sharing passwords

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete dashboards sharing passwords

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create dashboards sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Retrieve dashboards

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Update dashboards

Required API key scopes

Path parameters

Query parameters

Request parameters

Response

Example request