Environments-5 API Reference

Environments-5

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

Endpoints

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

Retrieve environments dashboards

Required API key scopes

dashboard:read

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Response

Example request

GET /api/environments/: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/environments/:project_id/dashboards/:id/

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,
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Retrieve environments dashboards

Required API key scopes

dashboard:read

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "json""txt"

Response

Example request

GET /api/environments/: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/environments/:project_id/dashboards/:id/

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,
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Response

Example request

PATCH /api/environments/: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/environments/:project_id/dashboards/:id/\
	-d name="string"

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,
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Update environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Response

Example request

PATCH /api/environments/: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/environments/:project_id/dashboards/:id/\
	-d name="string"

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,
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "_create_in_folder": "string"
}

Delete environments 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/environments/: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/environments/:project_id/dashboards/:id/

Example response

Status 405 No response body

Delete environments 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/environments/: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/environments/:project_id/dashboards/:id/

Example response

Status 405 No response body

Update environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Example request

PATCH /api/environments/: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/environments/:project_id/dashboards/:id/move_tile/\
	-d name="string"

Example response

Status 200 No response body

Update environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Example request

PATCH /api/environments/: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/environments/:project_id/dashboards/:id/move_tile/\
	-d name="string"

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

Query parameters

format
string
One of: "json""txt"

Example request

GET /api/environments/: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/environments/:project_id/dashboards/:id/stream_tiles/

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

Query parameters

format
string
One of: "json""txt"

Example request

GET /api/environments/: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/environments/:project_id/dashboards/:id/stream_tiles/

Example response

Status 200 No response body

Create environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Example request

POST /api/environments/: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/environments/:project_id/dashboards/create_from_template_json/\
	-d name="string"

Example response

Status 200 No response body

Create environments 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
use_template
string
use_dashboard
integer
delete_insights
boolean
Default: false
_create_in_folder
string

Example request

POST /api/environments/: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/environments/:project_id/dashboards/create_from_template_json/\
	-d name="string"

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.

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/environments/: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/environments/:project_id/dashboards/create_unlisted_dashboard/\
	-d name="string"

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.

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/environments/: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/environments/:project_id/dashboards/create_unlisted_dashboard/\
	-d name="string"

Example response

Status 200 No response body

List all environments 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/environments/: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/environments/:project_id/data_color_themes/

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"
      }
    }
  ]
}

List all environments 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/environments/: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/environments/:project_id/data_color_themes/

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"
      }
    }
  ]
}

Environments-5

Endpoints

Create environments dashboards sharing refresh

Required API key scopes

Path parameters

Request parameters

Response

Example request

Example response

Status 200

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

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

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

Delete environments dashboards

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 405 No response body

Update environments dashboards move tile

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Update environments dashboards move tile

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body