Dashboards-2 API Reference

Dashboards-2

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

Endpoints

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

Retrieve dashboards stream tiles retrieve

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

Example response

Status 200 No response body

Create dashboards create from template json create

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
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 create

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
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 list

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": "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": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      }
    }
  ]
}

Create data color themes create

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": "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": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  }
}

Retrieve data color themes retrieve

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

Example response

Status 200

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

Update data color themes update

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

Example response

Status 200

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

Delete data color themes destroy

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

Dashboards-2

Endpoints

Retrieve dashboards stream tiles retrieve

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Create dashboards create from template json create

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Create dashboards create unlisted dashboard create

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

List all data color themes list

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Create data color themes create

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 201

Retrieve data color themes retrieve

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Update data color themes update

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

Delete data color themes destroy

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Community questions