Environments-3 API Reference

Environments-3

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

Endpoints

`GET`	`/api/environments/:project_id/batch_exports/:id/logs/`
`POST`	`/api/environments/:project_id/batch_exports/:id/pause/`
`POST`	`/api/environments/:project_id/batch_exports/:id/unpause/`
`GET`	`/api/environments/:project_id/dashboards/`
`POST`	`/api/environments/:project_id/dashboards/`
`GET`	`/api/environments/:project_id/dashboards/:dashboard_id/collaborators/`
`POST`	`/api/environments/:project_id/dashboards/:dashboard_id/collaborators/`
`DELETE`	`/api/environments/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid/`
`GET`	`/api/environments/:project_id/dashboards/:dashboard_id/sharing/`
`GET`	`/api/environments/:project_id/dashboards/:id/`

Retrieve environments batch exports logs

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

GET /api/environments/:project_id/batch_exports/:id/logs

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/:id/logs/

Response

Status 200 No response body

Retrieve environments batch exports logs

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request

GET /api/environments/:project_id/batch_exports/:id/logs

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/:id/logs/

Response

Status 200 No response body

Create environments batch exports pause

Pause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
- sessions - Sessions
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string
filters

Request

POST /api/environments/:project_id/batch_exports/:id/pause

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/:id/pause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

Create environments batch exports pause

Pause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
- sessions - Sessions
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string
filters

Request

POST /api/environments/:project_id/batch_exports/:id/pause

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/:id/pause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

Create environments batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
- sessions - Sessions
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string
filters

Request

POST /api/environments/:project_id/batch_exports/:id/unpause

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/:id/unpause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

Create environments batch exports unpause

Unpause a BatchExport.

Required API key scopes

batch_export:write

Path parameters

id
string
A UUID string identifying this batch export.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
A human-readable name for this BatchExport.
model
Which model this BatchExport is exporting.
- events - Events
- persons - Persons
- sessions - Sessions
destination
interval
paused
boolean
Whether this BatchExport is paused or not.
last_paused_at
string
The timestamp at which this BatchExport was last paused.
start_at
string
Time before which any Batch Export runs won't be triggered.
end_at
string
Time after which any Batch Export runs won't be triggered.
hogql_query
string
filters

Request

POST /api/environments/:project_id/batch_exports/:id/unpause

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/:id/unpause/\
	-d name="string",\
	-d destination=undefined,\
	-d interval=undefined

Response

Status 200 No response body

List all environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

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/

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

List all environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

limit
integer
Number of results to return per page.
offset
integer
The initial index from which to return the results.

Response

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/

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

Create environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
description
string
pinned
boolean
deleted
boolean
use_template
string
use_dashboard
integer
delete_insights
boolean
tags
array
restriction_level

Response

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"

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"
  },
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "filters": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "tags": [
    null
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string"
}

Create environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

name
string
description
string
pinned
boolean
deleted
boolean
use_template
string
use_dashboard
integer
delete_insights
boolean
tags
array
restriction_level

Response

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"

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"
  },
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "filters": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "tags": [
    null
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string"
}

List all environments dashboards collaborators

Required API key scopes

dashboard:read

Path parameters

dashboard_id
integer
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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/

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
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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/

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
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

level
user_uuid
string

Response

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"

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
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request parameters

level
user_uuid
string

Response

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"

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
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
user__uuid
string

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/

Response

Status 204 No response body

Delete environments dashboards collaborators

Required API key scopes

dashboard:write

Path parameters

dashboard_id
integer
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
user__uuid
string

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/

Response

Status 204 No response body

Retrieve environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:read

Path parameters

id
integer
A unique integer value identifying this dashboard.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

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/

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"
  },
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "filters": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "tags": [
    null
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string"
}

Retrieve environments dashboards

Adds an "access_controls" action to the viewset that handles access control for the given resource

Why a mixin? We want to easily add this to any existing resource, including providing easy helpers for adding access control info such as the current users access level to any response.

Required API key scopes

dashboard:read

Path parameters

id
integer
A unique integer value identifying this dashboard.
project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

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/

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"
  },
  "is_shared": true,
  "deleted": true,
  "creation_mode": "default",
  "use_template": "string",
  "use_dashboard": 0,
  "delete_insights": false,
  "filters": {
    "property1": null,
    "property2": null
  },
  "variables": {
    "property1": null,
    "property2": null
  },
  "tags": [
    null
  ],
  "tiles": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "restriction_level": 21,
  "effective_restriction_level": 21,
  "effective_privilege_level": 21,
  "user_access_level": "string",
  "access_control_version": "string"
}