Environments-13 API Reference

Environments-13

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

    This endpoint allows you to list and filter events.
    It is effectively deprecated and is kept only for backwards compatibility.
    If you ever ask about it you will be advised to not use it...
    If you want to ad-hoc list or aggregate events, use the Query endpoint instead.
    If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.

Endpoints

`GET`
`GET`
`GET`
`GET`
`POST`
`GET`
`GET`
`GET`
`POST`
`GET`

List all environments events

Required API key scopes

query: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

after
string
Only return events with a timestamp after this time.
before
string
Only return events with a timestamp before this time.
distinct_id
integer
Filter list by distinct id.
event
string
Filter list by event. For example user sign up or $pageview.
format
string
One of: "csv""json"
limit
integer
The maximum number of results to return
offset
integer
The initial index from which to return the results.
person_id
integer
Filter list by person id.
properties
array
Filter events by event property, person property, cohort, groups and more.
select
array
(Experimental) JSON-serialized array of HogQL expressions to return
where
array
(Experimental) JSON-serialized array of HogQL expressions that must pass

Response

Example request

GET /api/environments/:project_id/events

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

Example response

Status 200

RESPONSE

{
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "results": [
    {
      "id": "string",
      "distinct_id": "string",
      "properties": "string",
      "event": "string",
      "timestamp": "string",
      "person": "string",
      "elements": "string",
      "elements_chain": "string"
    }
  ]
}

List all environments events

Required API key scopes

query: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

after
string
Only return events with a timestamp after this time.
before
string
Only return events with a timestamp before this time.
distinct_id
integer
Filter list by distinct id.
event
string
Filter list by event. For example user sign up or $pageview.
format
string
One of: "csv""json"
limit
integer
The maximum number of results to return
offset
integer
The initial index from which to return the results.
person_id
integer
Filter list by person id.
properties
array
Filter events by event property, person property, cohort, groups and more.
select
array
(Experimental) JSON-serialized array of HogQL expressions to return
where
array
(Experimental) JSON-serialized array of HogQL expressions that must pass

Response

Example request

GET /api/environments/:project_id/events

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

Example response

Status 200

RESPONSE

{
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "results": [
    {
      "id": "string",
      "distinct_id": "string",
      "properties": "string",
      "event": "string",
      "timestamp": "string",
      "person": "string",
      "elements": "string",
      "elements_chain": "string"
    }
  ]
}

Retrieve environments events

Required API key scopes

query:read

Path parameters

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

format
string
One of: "csv""json"

Response

Example request

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

Example response

Status 200

RESPONSE

{
  "id": "string",
  "distinct_id": "string",
  "properties": "string",
  "event": "string",
  "timestamp": "string",
  "person": "string",
  "elements": "string",
  "elements_chain": "string"
}

Retrieve environments events

Required API key scopes

query:read

Path parameters

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

format
string
One of: "csv""json"

Response

Example request

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

Example response

Status 200

RESPONSE

{
  "id": "string",
  "distinct_id": "string",
  "properties": "string",
  "event": "string",
  "timestamp": "string",
  "person": "string",
  "elements": "string",
  "elements_chain": "string"
}

Retrieve environments events values

Required API key scopes

query: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

format
string
One of: "csv""json"

Example request

GET /api/environments/:project_id/events/values

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

Example response

Status 200 No response body

Retrieve environments events values

Required API key scopes

query: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

format
string
One of: "csv""json"

Example request

GET /api/environments/:project_id/events/values

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

Example response

Status 200 No response body

List all environments exports

Required API key scopes

export: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

Example request

GET /api/environments/:project_id/exports

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

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,
      "dashboard": 0,
      "insight": 0,
      "export_format": "image/png",
      "created_at": "2019-08-24T14:15:22Z",
      "has_content": "string",
      "export_context": null,
      "filename": "string",
      "expires_after": "2019-08-24T14:15:22Z",
      "exception": "string"
    }
  ]
}

List all environments exports

Required API key scopes

export: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

Example request

GET /api/environments/:project_id/exports

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

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,
      "dashboard": 0,
      "insight": 0,
      "export_format": "image/png",
      "created_at": "2019-08-24T14:15:22Z",
      "has_content": "string",
      "export_context": null,
      "filename": "string",
      "expires_after": "2019-08-24T14:15:22Z",
      "exception": "string"
    }
  ]
}

Create environments exports

Required API key scopes

export: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

dashboard
integer
insight
integer
export_format
export_context

Response

Example request

POST /api/environments/:project_id/exports

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/exports/\
	-d export_format=undefined

Example response

Status 201

RESPONSE

{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "export_format": "image/png",
  "created_at": "2019-08-24T14:15:22Z",
  "has_content": "string",
  "export_context": null,
  "filename": "string",
  "expires_after": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Create environments exports

Required API key scopes

export: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

dashboard
integer
insight
integer
export_format
export_context

Response

Example request

POST /api/environments/:project_id/exports

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/exports/\
	-d export_format=undefined

Example response

Status 201

RESPONSE

{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "export_format": "image/png",
  "created_at": "2019-08-24T14:15:22Z",
  "has_content": "string",
  "export_context": null,
  "filename": "string",
  "expires_after": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Retrieve environments exports

Required API key scopes

export:read

Path parameters

id
integer
A unique integer value identifying this exported asset.
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

Example request

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

Example response

Status 200

RESPONSE

{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "export_format": "image/png",
  "created_at": "2019-08-24T14:15:22Z",
  "has_content": "string",
  "export_context": null,
  "filename": "string",
  "expires_after": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Retrieve environments exports

Required API key scopes

export:read

Path parameters

id
integer
A unique integer value identifying this exported asset.
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

Example request

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

Example response

Status 200

RESPONSE

{
  "id": 0,
  "dashboard": 0,
  "insight": 0,
  "export_format": "image/png",
  "created_at": "2019-08-24T14:15:22Z",
  "has_content": "string",
  "export_context": null,
  "filename": "string",
  "expires_after": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Retrieve environments exports content

Required API key scopes

export:read

Path parameters

id
integer
A unique integer value identifying this exported asset.
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/.

Example request

GET /api/environments/:project_id/exports/:id/content

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

Example response

Status 200 No response body

Retrieve environments exports content

Required API key scopes

export:read

Path parameters

id
integer
A unique integer value identifying this exported asset.
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/.

Example request

GET /api/environments/:project_id/exports/:id/content

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

Example response

Status 200 No response body

List all environments file system

Required API key scopes

file_system: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.
search
string
A search term.

Response

Example request

GET /api/environments/:project_id/file_system

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "path": "string",
      "depth": 0,
      "type": "string",
      "ref": "string",
      "href": "string",
      "meta": null,
      "shortcut": true,
      "created_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z"
    }
  ]
}

List all environments file system

Required API key scopes

file_system: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.
search
string
A search term.

Response

Example request

GET /api/environments/:project_id/file_system

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "path": "string",
      "depth": 0,
      "type": "string",
      "ref": "string",
      "href": "string",
      "meta": null,
      "shortcut": true,
      "created_at": "2019-08-24T14:15:22Z",
      "last_viewed_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create environments file system

Required API key scopes

file_system: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

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Response

Example request

POST /api/environments/:project_id/file_system

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/file_system/\
	-d path="string"

Example response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Create environments file system

Required API key scopes

file_system: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

path
string
type
string
ref
string
href
string
meta
shortcut
boolean

Response

Example request

POST /api/environments/:project_id/file_system

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/file_system/\
	-d path="string"

Example response

Status 201

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system

Required API key scopes

file_system:read

Path parameters

id
string
A UUID string identifying this file system.
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

Example request

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

Example response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}

Retrieve environments file system

Required API key scopes

file_system:read

Path parameters

id
string
A UUID string identifying this file system.
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

Example request

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

Example response

Status 200

RESPONSE

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "path": "string",
  "depth": 0,
  "type": "string",
  "ref": "string",
  "href": "string",
  "meta": null,
  "shortcut": true,
  "created_at": "2019-08-24T14:15:22Z",
  "last_viewed_at": "2019-08-24T14:15:22Z"
}