Core API Reference

Next page →

List all environments dashboards

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

Required API key scopes

dashboard:read

Query parameters

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

Response

Example request

GET /api/environments/:environment_id/dashboards
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dashboards/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_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",
      "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
    }
  ]
}

Create environments 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"

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/environments/:environment_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/environments/:environment_id/dashboards/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_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",
  "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 environments 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"
variables_override
string

Response

Example request

GET /api/environments/:environment_id/dashboards/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/dashboards/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/".format(
        project_id=project_id,
		core_id="<the core 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",
  "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 environments 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"

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

PATCH /api/environments/:environment_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/environments/:environment_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/environments/{environment_id}/dashboards/{core_id}/".format(
        project_id=project_id,
		core_id="<the core 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",
  "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 environments 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/environments/:environment_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/environments/:environment_id/dashboards/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/".format(
        project_id=project_id,
		core_id="<the core id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create environments dashboards analyze refresh result

Generate AI analysis comparing before/after dashboard refresh. Expects cache_key in request body pointing to the stored 'before' state.

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

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

Example request

POST /api/environments/:environment_id/dashboards/:id/analyze_refresh_result
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/environments/:environment_id/dashboards/:id/analyze_refresh_result/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/analyze_refresh_result/".format(
        project_id=project_id,
		core_id="<the core id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Create environments dashboards copy tile

Copy an existing dashboard tile to another dashboard (insight or text card; new tile row).

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/environments/:environment_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/environments/:environment_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/environments/{environment_id}/dashboards/{core_id}/copy_tile/".format(
        project_id=project_id,
		core_id="<the core 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",
  "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 environments dashboards move tile

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

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

Example request

PATCH /api/environments/:environment_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/environments/:environment_id/dashboards/:id/move_tile/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/move_tile/".format(
        project_id=project_id,
		core_id="<the core id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Create environments 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

Response

Example request

POST /api/environments/:environment_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/environments/:environment_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/environments/{environment_id}/dashboards/{core_id}/reorder_tiles/".format(
        project_id=project_id,
		core_id="<the core 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",
  "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 environments 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/environments/:environment_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/environments/:environment_id/dashboards/:id/run_insights/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/run_insights/".format(
        project_id=project_id,
		core_id="<the core 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
      }
    }
  ]
}

Create environments dashboards snapshot

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.

Path parameters

id
integer

Query parameters

format
string
One of: "json""txt"

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

Example request

POST /api/environments/:environment_id/dashboards/:id/snapshot
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/environments/:environment_id/dashboards/:id/snapshot/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/{core_id}/snapshot/".format(
        project_id=project_id,
		core_id="<the core id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Retrieve environments dashboards stream tiles

Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.

Path parameters

id
integer

Query parameters

filters_override
string
format
string
One of: "json""txt"
layoutSize
string
One of: "sm""xs"
variables_override
string

Example request

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

Example response

Status 200 No response body

Create environments dashboards bulk update tags

Bulk update tags on multiple objects.

PAT access: this action has no required_scopes= on the decorator — inheriting viewsets must add "bulk_update_tags" to their scope_object_write_actions list to accept personal API keys. Without that opt-in, APIScopePermission rejects PAT requests with "This action does not support personal API key access". Done per-viewset so granting <scope>:write for one resource doesn't leak access to sibling resources that share this mixin.

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

Query parameters

format
string
One of: "json""txt"

Request parameters

ids
array
action
tags
array

Response

Example request

POST /api/environments/:environment_id/dashboards/bulk_update_tags
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/environments/:environment_id/dashboards/bulk_update_tags/\
	-d ids="array",\
	-d action=undefined,\
	-d tags="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/bulk_update_tags/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"ids": "array",
		"tags": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "updated": [
    {
      "id": 0,
      "tags": [
        "string"
      ]
    }
  ],
  "skipped": [
    {
      "id": 0,
      "reason": "string"
    }
  ]
}

Create environments dashboards create from template json

Query parameters

format
string
One of: "json""txt"

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

Example request

POST /api/environments/:environment_id/dashboards/create_from_template_json
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/environments/:environment_id/dashboards/create_from_template_json/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/create_from_template_json/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Create environments dashboards create unlisted dashboard

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.

Query parameters

format
string
One of: "json""txt"

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

Example request

POST /api/environments/:environment_id/dashboards/create_unlisted_dashboard
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/environments/:environment_id/dashboards/create_unlisted_dashboard/\
	-d name=["string","null"]
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/dashboards/create_unlisted_dashboard/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": [
			"string",
			"null"
		]
	}
).json()

Example response

Status 200 No response body

Next page →

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

Core

Endpoints

List all environments dashboards

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Create environments dashboards

Required API key scopes

Query parameters

Request parameters

Response

Example request

Example response

Status 201

List all environments dashboards sharing

Required API key scopes

Path parameters

Example request

Example response

Status 200

Create environments dashboards sharing passwords

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments dashboards sharing passwords

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Create environments dashboards sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Retrieve environments dashboards

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Update environments dashboards

Required API key scopes

Path parameters

Query parameters

Request parameters

Response

Example request

Example response

Status 200

Delete environments dashboards

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 405 No response body

Create environments dashboards analyze refresh result

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Create environments dashboards copy tile

Required API key scopes

Path parameters

Query parameters