Environments-9

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

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

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/

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

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/

Response

Status 200 No response body

List all environments groups

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

Required API key scopes

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

  • cursor
    string

    The pagination cursor value.

  • group_type_index
    integer

    Specify the group type to list

  • search
    string

    Search the group name

Response


Request

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

Response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

List all environments groups

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

Required API key scopes

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

  • cursor
    string

    The pagination cursor value.

  • group_type_index
    integer

    Specify the group type to list

  • search
    string

    Search the group name

Response


Request

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

Response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Retrieve environments groups activity

Required API key scopes

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

  • group_type_index
    integer

    Specify the group type to find

  • id
    string

    Specify the id of the user to find groups for

Request

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

Response

Status 200 No response body

Retrieve environments groups activity

Required API key scopes

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

  • group_type_index
    integer

    Specify the group type to find

  • id
    string

    Specify the id of the user to find groups for

Request

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

Response

Status 200 No response body

Create environments groups delete property

Required API key scopes

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

Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Request

POST /api/environments/:project_id/groups/delete_property
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/groups/delete_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Response

Status 200 No response body

Create environments groups delete property

Required API key scopes

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

Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Request

POST /api/environments/:project_id/groups/delete_property
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/groups/delete_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Response

Status 200 No response body

Retrieve environments groups find

Required API key scopes

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

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request

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

Response

Status 200 No response body

Retrieve environments groups find

Required API key scopes

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

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request

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

Response

Status 200 No response body

Retrieve environments groups property definitions

Required API key scopes

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

Request

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

Response

Status 200 No response body

Retrieve environments groups property definitions

Required API key scopes

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

Request

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

Response

Status 200 No response body

Retrieve environments groups property values

Required API key scopes

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

Request

GET /api/environments/:project_id/groups/property_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/groups/property_values/

Response

Status 200 No response body

Retrieve environments groups property values

Required API key scopes

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

Request

GET /api/environments/:project_id/groups/property_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/groups/property_values/

Response

Status 200 No response body

Create environments groups update property

Required API key scopes

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

Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Request

POST /api/environments/:project_id/groups/update_property
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/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Response

Status 200 No response body

Create environments groups update property

Required API key scopes

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

Query parameters

  • group_key
    string

    Specify the key of the group to find

  • group_type_index
    integer

    Specify the group type to find

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Request

POST /api/environments/:project_id/groups/update_property
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/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Response

Status 200 No response body

List all environments hog functions

Required API key scopes

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

  • created_at
    string
  • created_by
    integer
  • enabled
    boolean
  • exclude_kind
    array

    Multiple values may be separated by commas.

  • id
    string
  • kind
    array

    Multiple values may be separated by commas.

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • type
    array

    Multiple values may be separated by commas.

  • updated_at
    string

Response


Request

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

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",
      "type": "string",
      "kind": "string",
      "name": "string",
      "description": "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"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "enabled": true,
      "hog": "string",
      "filters": null,
      "icon_url": "string",
      "template": "string",
      "status": {
        "state": 0,
        "rating": 0.1,
        "tokens": 0
      },
      "execution_order": 0
    }
  ]
}

List all environments hog functions

Required API key scopes

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

  • created_at
    string
  • created_by
    integer
  • enabled
    boolean
  • exclude_kind
    array

    Multiple values may be separated by commas.

  • id
    string
  • kind
    array

    Multiple values may be separated by commas.

  • limit
    integer

    Number of results to return per page.

  • offset
    integer

    The initial index from which to return the results.

  • type
    array

    Multiple values may be separated by commas.

  • updated_at
    string

Response


Request

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

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",
      "type": "string",
      "kind": "string",
      "name": "string",
      "description": "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"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "enabled": true,
      "hog": "string",
      "filters": null,
      "icon_url": "string",
      "template": "string",
      "status": {
        "state": 0,
        "rating": 0.1,
        "tokens": 0
      },
      "execution_order": 0
    }
  ]
}
Next page →

Community questions

Was this page useful?