Environments-15 API Reference

Environments-15

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

Endpoints

`POST`
`GET`
`GET`
`GET`
`GET`
`GET`
`PATCH`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`GET`

Create hog functions invocations

Path parameters

id
string
project_id
string

Request parameters

type
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

Example request

POST /api/environments/:project_id/hog_functions/:id/invocations
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/hog_functions/:id/invocations/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/{environments-15_id}/invocations/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

Retrieve hog functions logs

Path parameters

id
string
project_id
string

Example request

GET /api/environments/:project_id/hog_functions/: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/hog_functions/:id/logs/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/{environments-15_id}/logs/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions metrics

Path parameters

id
string
project_id
string

Example request

GET /api/environments/:project_id/hog_functions/:id/metrics
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/:id/metrics/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/{environments-15_id}/metrics/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions metrics totals

Path parameters

id
string
project_id
string

Example request

GET /api/environments/:project_id/hog_functions/:id/metrics/totals
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/:id/metrics/totals/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/{environments-15_id}/metrics/totals/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions icon

Path parameters

project_id
string

Example request

GET /api/environments/:project_id/hog_functions/icon
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/icon/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/icon/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve hog functions icons

Path parameters

project_id
string

Example request

GET /api/environments/:project_id/hog_functions/icons
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/icons/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/icons/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update hog functions rearrange

Update the execution order of multiple HogFunctions.

Path parameters

project_id
string

Request parameters

type
name
string
description
string
enabled
boolean
deleted
boolean
hog
string
inputs_schema
array
inputs
object
filters
masking
mappings
array
icon_url
string
template_id
string
execution_order
integer
_create_in_folder
string

Example request

PATCH /api/environments/:project_id/hog_functions/rearrange
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/hog_functions/rearrange/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/hog_functions/rearrange/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200 No response body

List all insight variables

Required API key scopes

insight_variable:read

Path parameters

project_id
string

Query parameters

page
integer

Response

Example request

GET /api/environments/:project_id/insight_variables
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/insight_variables/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "type": "String",
      "default_value": null,
      "created_by": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "code_name": "string",
      "values": null
    }
  ]
}

List all insight variables

Required API key scopes

insight_variable:read

Path parameters

project_id
string

Query parameters

page
integer

Response

Example request

GET /api/environments/:project_id/insight_variables
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/insight_variables/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "type": "String",
      "default_value": null,
      "created_by": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "code_name": "string",
      "values": null
    }
  ]
}

Create insight variables

Required API key scopes

insight_variable:write

Path parameters

project_id
string

Request parameters

name
string
type
default_value
values

Response

Example request

POST /api/environments/:project_id/insight_variables
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/insight_variables/\
	-d name="string",\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Create insight variables

Required API key scopes

insight_variable:write

Path parameters

project_id
string

Request parameters

name
string
type
default_value
values

Response

Example request

POST /api/environments/:project_id/insight_variables
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/insight_variables/\
	-d name="string",\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Retrieve insight variables

Required API key scopes

insight_variable:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/insight_variables/: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/insight_variables/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Retrieve insight variables

Required API key scopes

insight_variable:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/insight_variables/: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/insight_variables/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Update insight variables

Required API key scopes

insight_variable:write

Path parameters

id
string
project_id
string

Request parameters

name
string
type
default_value
values

Response

Example request

PATCH /api/environments/:project_id/insight_variables/:id
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/insight_variables/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Update insight variables

Required API key scopes

insight_variable:write

Path parameters

id
string
project_id
string

Request parameters

name
string
type
default_value
values

Response

Example request

PATCH /api/environments/:project_id/insight_variables/:id
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/insight_variables/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "type": "String",
  "default_value": null,
  "created_by": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "code_name": "string",
  "values": null
}

Delete insight variables

Required API key scopes

insight_variable:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/insight_variables/: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/insight_variables/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete insight variables

Required API key scopes

insight_variable:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/insight_variables/: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/insight_variables/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/insight_variables/{environments-15_id}/".format(
        project_id=project_id,
		environments-15_id="<the environments-15 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

List all insights

Required API key scopes

insight:read

Path parameters

project_id
string

Query parameters

basic
boolean
format
string
One of: "csv""json"
limit
integer
offset
integer
refresh
string
Default: force_cache
One of: "async""async_except_on_cache_miss""blocking""force_async""force_blocking""force_cache""lazy_async"
short_id
string

Response

Example request

GET /api/environments/:project_id/insights
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/insights/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/insights/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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,
      "short_id": "string",
      "name": "string",
      "derived_name": "string",
      "query": {
        "kind": "InsightVizNode",
        "source": {
          "kind": "TrendsQuery",
          "series": [
            {
              "kind": "EventsNode",
              "math": "total",
              "name": "$pageview",
              "event": "$pageview",
              "version": 1
            }
          ],
          "version": 1
        },
        "version": 1
      },
      "order": -2147483648,
      "deleted": true,
      "dashboards": [
        0
      ],
      "dashboard_tiles": [
        {
          "id": 0,
          "dashboard_id": 0,
          "deleted": true
        }
      ],
      "last_refresh": "string",
      "cache_target_age": "string",
      "next_allowed_client_refresh": "string",
      "result": "string",
      "hasMore": "string",
      "columns": "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"
      },
      "description": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "tags": [
        null
      ],
      "favorited": true,
      "last_modified_at": "2019-08-24T14:15:22Z",
      "last_modified_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_sample": true,
      "effective_restriction_level": 21,
      "effective_privilege_level": 21,
      "user_access_level": "string",
      "timezone": "string",
      "is_cached": "string",
      "query_status": "string",
      "hogql": "string",
      "types": "string",
      "resolved_date_range": "string",
      "_create_in_folder": "string",
      "alerts": "string",
      "last_viewed_at": "string"
    }
  ]
}