Environments-4

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

Endpoints

POST
GET
GET
POST
GET
POST
DELETE
GET
POST
DELETE

Create environments batch exports run test step new

Required API key scopes

INTERNAL

Path parameters

  • project_id
    string

Request parameters

  • name
    string
  • model
  • destination
  • interval
  • paused
    boolean
  • last_paused_at
    string
  • start_at
    string
  • end_at
    string
  • hogql_query
    string
  • filters

Example request

POST /api/environments/:project_id/batch_exports/run_test_step_new
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/batch_exports/run_test_step_new/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Example response

Status 200 No response body

Create environments batch exports run test step new

Required API key scopes

INTERNAL

Path parameters

  • project_id
    string

Request parameters

  • name
    string
  • model
  • destination
  • interval
  • paused
    boolean
  • last_paused_at
    string
  • start_at
    string
  • end_at
    string
  • hogql_query
    string
  • filters

Example request

POST /api/environments/:project_id/batch_exports/run_test_step_new
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/batch_exports/run_test_step_new/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Example response

Status 200 No response body

Retrieve environments batch exports test

Required API key scopes

INTERNAL

Path parameters

  • project_id
    string

Example request

GET /api/environments/:project_id/batch_exports/test
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/batch_exports/test/

Example response

Status 200 No response body

Retrieve environments batch exports test

Required API key scopes

INTERNAL

Path parameters

  • project_id
    string

Example request

GET /api/environments/:project_id/batch_exports/test
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/batch_exports/test/

Example response

Status 200 No response body

List all environments dashboards

Required API key scopes

dashboard:read

Path parameters

  • project_id
    string

Query parameters

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

Response


Example request

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

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": {
          "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",
      "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
    }
  ]
}

List all environments dashboards

Required API key scopes

dashboard:read

Path parameters

  • project_id
    string

Query parameters

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

Response


Example request

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

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": {
          "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",
      "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

Required API key scopes

dashboard:write

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

Response


Example request

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

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": {
      "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"
}

Create environments dashboards

Required API key scopes

dashboard:write

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

Response


Example request

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

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": {
      "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"
}

List all environments dashboards collaborators

Required API key scopes

dashboard:read

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Example request

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

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

List all environments dashboards collaborators

Required API key scopes

dashboard:read

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Example request

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

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": {
      "property1": null,
      "property2": null
    },
    "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 environments dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Request parameters

  • level
  • user_uuid
    string

Response


Example request

POST /api/environments/: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/environments/:project_id/dashboards/:dashboard_id/collaborators/\
	-d level=undefined,\
	-d user_uuid="string"

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": {
      "property1": null,
      "property2": null
    },
    "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 environments dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Request parameters

  • level
  • user_uuid
    string

Response


Example request

POST /api/environments/: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/environments/:project_id/dashboards/:dashboard_id/collaborators/\
	-d level=undefined,\
	-d user_uuid="string"

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": {
      "property1": null,
      "property2": null
    },
    "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 environments dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string
  • user__uuid
    string

Example request

DELETE /api/environments/: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/environments/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid/

Example response

Status 204 No response body

Delete environments dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string
  • user__uuid
    string

Example request

DELETE /api/environments/: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/environments/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid/

Example response

Status 204 No response body

List all environments dashboards sharing

Required API key scopes

sharing_configuration:read

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Example request

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

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

List all environments dashboards sharing

Required API key scopes

sharing_configuration:read

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Example request

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

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create environments dashboards sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/environments/:project_id/dashboards/:dashboard_id/sharing/passwords
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/:dashboard_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create environments dashboards sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/environments/:project_id/dashboards/:dashboard_id/sharing/passwords
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/:dashboard_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Delete environments dashboards sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer
  • password_id
    string
  • project_id
    string

Example request

DELETE /api/environments/:project_id/dashboards/:dashboard_id/sharing/passwords/:password_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/:dashboard_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Delete environments dashboards sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • dashboard_id
    integer
  • password_id
    string
  • project_id
    string

Example request

DELETE /api/environments/:project_id/dashboards/:dashboard_id/sharing/passwords/:password_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/:dashboard_id/sharing/passwords/:password_id/

Example response

Status 204 No response body
Next page →

Community questions

Questions about this page? or post a community question.