Dashboards-3 API Reference

Dashboards-3

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

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

Update dashboards

Required API key scopes

dashboard:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

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"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboards-3_id}/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).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": {
      "property1": null,
      "property2": null
    },
    "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": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "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": {
    "property1": null,
    "property2": null
  },
  "persisted_variables": {
    "property1": null,
    "property2": null
  },
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Delete dashboards

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
project_id
string

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/{dashboards-3_id}/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create 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
project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

Example request

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

Example response

Status 200 No response body

Create 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
project_id
string

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/{dashboards-3_id}/copy_tile/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 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": {
      "property1": null,
      "property2": null
    },
    "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": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "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": {
    "property1": null,
    "property2": null
  },
  "persisted_variables": {
    "property1": null,
    "property2": null
  },
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Create dashboards generate metadata

Generate an AI-suggested name and description from this dashboard's tiles.

Required API key scopes

dashboard:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Response

Example request

POST /api/projects/:project_id/dashboards/:id/generate_metadata
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/generate_metadata/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboards-3_id}/generate_metadata/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "name": "string",
  "description": "string"
}

Update dashboards move tile

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

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 name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboards-3_id}/move_tile/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200 No response body

Create dashboards reorder tiles

Required API key scopes

dashboard:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

tile_order
array

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/{dashboards-3_id}/reorder_tiles/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 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": {
      "property1": null,
      "property2": null
    },
    "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": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "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": {
    "property1": null,
    "property2": null
  },
  "persisted_variables": {
    "property1": null,
    "property2": null
  },
  "team_id": 0,
  "quick_filter_ids": [
    "string"
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "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
project_id
string

Query parameters

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

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/{dashboards-3_id}/run_insights/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 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 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
project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

Example request

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

Example response

Status 200 No response body

Retrieve 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
project_id
string

Query parameters

format
string
One of: "json""txt"

Example request

GET /api/projects/:project_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/projects/:project_id/dashboards/:id/stream_tiles/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/dashboards/{dashboards-3_id}/stream_tiles/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Create dashboards bulk update tags

Bulk update tags on multiple objects.

Accepts:

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

Actions:

"add": Add tags to existing tags on each object
"remove": Remove specific tags from each object
"set": Replace all tags on each object with the provided list

Path parameters

project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

ids
array
action
tags
array

Response

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_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 dashboards create from template json

Path parameters

project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

Example request

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

Example response

Status 200 No response body

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

Path parameters

project_id
string

Query parameters

format
string
One of: "json""txt"

Request parameters

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

Example request

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

Example response

Status 200 No response body

List all data color themes

Required API key scopes

project:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/data_color_themes
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/data_color_themes/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_color_themes/".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",
      "colors": null,
      "is_global": 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": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      }
    }
  ]
}

Create data color themes

Required API key scopes

project:write

Path parameters

project_id
string

Request parameters

name
string
colors

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": 0,
  "name": "string",
  "colors": null,
  "is_global": 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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Retrieve data color themes

Required API key scopes

project:read

Path parameters

id
integer
project_id
string

Response

Example request

GET /api/projects/:project_id/data_color_themes/: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/data_color_themes/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/data_color_themes/{dashboards-3_id}/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "colors": null,
  "is_global": 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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Update data color themes

Required API key scopes

project:write

Path parameters

id
integer
project_id
string

Request parameters

name
string
colors

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": 0,
  "name": "string",
  "colors": null,
  "is_global": 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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Delete data color themes

Required API key scopes

project:write

Path parameters

id
integer
project_id
string

Example request

DELETE /api/projects/:project_id/data_color_themes/: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/data_color_themes/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/data_color_themes/{dashboards-3_id}/".format(
        project_id=project_id,
		dashboards-3_id="<the dashboards-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)