Environments-16 API Reference

Environments-16

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

Endpoints

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

Update environments insights

Required API key scopes

insight:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Response

Example request

PATCH /api/environments/:project_id/insights/: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/insights/: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}/insights/{environments-16_id}/".format(
        project_id=project_id,
		environments-16_id="<the environments-16 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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"
}

Update environments insights

Required API key scopes

insight:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Response

Example request

PATCH /api/environments/:project_id/insights/: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/insights/: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}/insights/{environments-16_id}/".format(
        project_id=project_id,
		environments-16_id="<the environments-16 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "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"
}

Delete environments insights

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

insight:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 405 No response body

Delete environments insights

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

insight:write

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 405 No response body

Retrieve environments insights activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights analyze

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights analyze

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights suggestions

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights suggestions

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Create environments insights suggestions

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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

Example response

Status 200 No response body

Create environments insights suggestions

Path parameters

id
integer
project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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

Example response

Status 200 No response body

Retrieve environments insights activity

Required API key scopes

activity_log:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights activity

Required API key scopes

activity_log:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Create environments insights cancel

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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

Example response

Status 200 No response body

Create environments insights cancel

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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

Example response

Status 200 No response body

Retrieve environments insights my last viewed

Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve environments insights my last viewed

Returns basic details about the last 5 insights viewed by this user. Most recently viewed first.

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Create environments insights viewed

Update insight view timestamps. Expects: {"insight_ids": [1, 2, 3, ...]}

Required API key scopes

insight:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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

Example response

Status 200 No response body

Create environments insights viewed

Update insight view timestamps. Expects: {"insight_ids": [1, 2, 3, ...]}

Required API key scopes

insight:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Request parameters

name
string
derived_name
string
query
object
order
integer
deleted
boolean
dashboards
array
description
string
tags
array
favorited
boolean
_create_in_folder
string

Example request

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