Environments-4

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

Update environments dashboards move tile

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/.

Request parameters

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

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"

Response

Status 200 No response body

Update environments dashboards move tile

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/.

Request parameters

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

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"

Response

Status 200 No response body

Create environments dashboards create from template json

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

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"

Response

Status 200 No response body

Create environments dashboards create from template json

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

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"

Response

Status 200 No response body

List all environments events

    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.

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
    Click to open
    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


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/

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

    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.

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
    Click to open
    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


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/

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


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/

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


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/

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"

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/

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"

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/

Response

Status 200 No response body

List all environments explicit members

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

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

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

List all environments explicit members

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

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

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Create environments explicit members

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

  • level
  • user_uuid
    string

Response


Request

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

Response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Create environments explicit members

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

  • level
  • user_uuid
    string

Response


Request

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

Response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Retrieve environments explicit members

Path parameters

  • parent_membership__user__uuid
    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/.

Response


Request

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

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Retrieve environments explicit members

Path parameters

  • parent_membership__user__uuid
    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/.

Response


Request

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

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Update environments explicit members

Path parameters

  • parent_membership__user__uuid
    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/.

Request parameters

  • level
  • user_uuid
    string

Response


Request

PATCH /api/environments/:project_id/explicit_members/:parent_membership__user__uuid
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/explicit_members/:parent_membership__user__uuid/\
	-d level=undefined

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}

Update environments explicit members

Path parameters

  • parent_membership__user__uuid
    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/.

Request parameters

  • level
  • user_uuid
    string

Response


Request

PATCH /api/environments/:project_id/explicit_members/:parent_membership__user__uuid
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/explicit_members/:parent_membership__user__uuid/\
	-d level=undefined

Response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "level": 1,
  "parent_level": 0,
  "parent_membership_id": "fc5297bf-5fc6-4091-bb49-da6d2410e235",
  "joined_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "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
    }
  },
  "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
  "effective_level": 1
}
Next page →

Questions?

Was this page useful?