Environments-25 API Reference

Environments-25

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

Create, Read, Update and Delete Warehouse Tables.

Endpoints

`DELETE`	`/api/environments/:project_id/warehouse_tables/:id/`
`POST`	`/api/environments/:project_id/warehouse_tables/:id/refresh_schema/`
`POST`	`/api/environments/:project_id/warehouse_tables/:id/update_schema/`
`POST`	`/api/environments/:project_id/warehouse_tables/file/`
`GET`	`/api/environments/:project_id/web_vitals/`
`GET`	`/api/projects/:project_id/environments/`
`POST`	`/api/projects/:project_id/environments/`
`GET`	`/api/projects/:project_id/environments/:id/`
`PATCH`	`/api/projects/:project_id/environments/:id/`
`DELETE`	`/api/projects/:project_id/environments/:id/`
`GET`	`/api/projects/:project_id/environments/:id/activity/`
`PATCH`	`/api/projects/:project_id/environments/:id/add_product_intent/`
`PATCH`	`/api/projects/:project_id/environments/:id/complete_product_onboarding/`
`PATCH`	`/api/projects/:project_id/environments/:id/delete_secret_token_backup/`

Delete environments warehouse tables

Required API key scopes

warehouse_table:write

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

DELETE /api/environments/:project_id/warehouse_tables/: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/warehouse_tables/:id/

Response

Status 204 No response body

Delete environments warehouse tables

Required API key scopes

warehouse_table:write

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

DELETE /api/environments/:project_id/warehouse_tables/: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/warehouse_tables/:id/

Response

Status 204 No response body

Create environments warehouse tables refresh schema

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

deleted
boolean
name
string
format
url_pattern
string
credential

Request

POST /api/environments/:project_id/warehouse_tables/:id/refresh_schema

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/warehouse_tables/:id/refresh_schema/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Response

Status 200 No response body

Create environments warehouse tables refresh schema

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

deleted
boolean
name
string
format
url_pattern
string
credential

Request

POST /api/environments/:project_id/warehouse_tables/:id/refresh_schema

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/warehouse_tables/:id/refresh_schema/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Response

Status 200 No response body

Create environments warehouse tables update schema

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

deleted
boolean
name
string
format
url_pattern
string
credential

Request

POST /api/environments/:project_id/warehouse_tables/:id/update_schema

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/warehouse_tables/:id/update_schema/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Response

Status 200 No response body

Create environments warehouse tables update schema

Path parameters

id
string
A UUID string identifying this data warehouse table.
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

deleted
boolean
name
string
format
url_pattern
string
credential

Request

POST /api/environments/:project_id/warehouse_tables/:id/update_schema

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/warehouse_tables/:id/update_schema/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Response

Status 200 No response body

Create environments warehouse tables file

Required API key scopes

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

Response

Status 200 No response body

Create environments warehouse tables file

Required API key scopes

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

Response

Status 200 No response body

Retrieve environments web vitals

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

pathname
string
Filter web vitals by pathname

Request

GET /api/environments/:project_id/web_vitals

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

Response

Status 200 No response body

Retrieve environments web vitals

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

pathname
string
Filter web vitals by pathname

Request

GET /api/environments/:project_id/web_vitals

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

Response

Status 200 No response body

List all environments

Projects for the current organization.

Required API key scopes

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

Request

GET /api/projects/:project_id/environments

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

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,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
      "project_id": -9223372036854776000,
      "api_token": "string",
      "name": "string",
      "completed_snippet_onboarding": true,
      "has_completed_onboarding_for": null,
      "ingested_event": true,
      "is_demo": true,
      "timezone": "Africa/Abidjan",
      "access_control": true
    }
  ]
}

Create environments

Projects for the current organization.

Required API key scopes

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

name
string
access_control
boolean
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
array
session_recording_url_blocklist_config
array
session_recording_event_trigger_config
array
session_recording_trigger_match_type_config
string
session_replay_config
survey_config
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
cookieless_server_hash_mode
human_friendly_comparison_periods
boolean
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean
flags_persistence_default
boolean
feature_flag_confirmation_enabled
boolean
feature_flag_confirmation_message
string
capture_dead_clicks
boolean
default_data_theme
integer
revenue_analytics_config
marketing_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
boolean

Response

Request

POST /api/projects/:project_id/environments

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/projects/:project_id/environments/\
	-d uuid="string"

Response

Status 201

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "access_control": true,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "project_id": -9223372036854776000,
  "api_token": "string",
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "ingested_event": true,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "person_on_events_querying_enabled": true,
  "user_access_level": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_web_vitals_allowed_metrics": null,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_recording_url_trigger_config": [
    null
  ],
  "session_recording_url_blocklist_config": [
    null
  ],
  "session_recording_event_trigger_config": [
    "string"
  ],
  "session_recording_trigger_match_type_config": "string",
  "session_replay_config": null,
  "survey_config": null,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "flags_persistence_default": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "capture_dead_clicks": true,
  "default_data_theme": -2147483648,
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "goals": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": null,
    "conversion_goals": null
  },
  "onboarding_tasks": null,
  "base_currency": "USD",
  "web_analytics_pre_aggregated_tables_enabled": true,
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "product_intents": "string"
}

Retrieve environments

Projects for the current organization.

Required API key scopes

project:read

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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/projects/:project_id/environments/:id

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

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "access_control": true,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "project_id": -9223372036854776000,
  "api_token": "string",
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "ingested_event": true,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "person_on_events_querying_enabled": true,
  "user_access_level": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_web_vitals_allowed_metrics": null,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_recording_url_trigger_config": [
    null
  ],
  "session_recording_url_blocklist_config": [
    null
  ],
  "session_recording_event_trigger_config": [
    "string"
  ],
  "session_recording_trigger_match_type_config": "string",
  "session_replay_config": null,
  "survey_config": null,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "flags_persistence_default": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "capture_dead_clicks": true,
  "default_data_theme": -2147483648,
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "goals": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": null,
    "conversion_goals": null
  },
  "onboarding_tasks": null,
  "base_currency": "USD",
  "web_analytics_pre_aggregated_tables_enabled": true,
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "product_intents": "string"
}

Update environments

Projects for the current organization.

Required API key scopes

team:read

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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
access_control
boolean
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
array
session_recording_url_blocklist_config
array
session_recording_event_trigger_config
array
session_recording_trigger_match_type_config
string
session_replay_config
survey_config
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
cookieless_server_hash_mode
human_friendly_comparison_periods
boolean
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean
flags_persistence_default
boolean
feature_flag_confirmation_enabled
boolean
feature_flag_confirmation_message
string
capture_dead_clicks
boolean
default_data_theme
integer
revenue_analytics_config
marketing_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
boolean

Response

Request

PATCH /api/projects/:project_id/environments/:id

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/\
	-d uuid="string"

Response

Status 200

RESPONSE

{
  "id": 0,
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "name": "string",
  "access_control": true,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "project_id": -9223372036854776000,
  "api_token": "string",
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "ingested_event": true,
  "default_modifiers": {
    "property1": null,
    "property2": null
  },
  "person_on_events_querying_enabled": true,
  "user_access_level": "string",
  "app_urls": [
    "string"
  ],
  "slack_incoming_webhook": "string",
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "test_account_filters": null,
  "test_account_filters_default_checked": true,
  "path_cleaning_filters": null,
  "is_demo": true,
  "timezone": "Africa/Abidjan",
  "data_attributes": null,
  "person_display_name_properties": [
    "string"
  ],
  "correlation_config": null,
  "autocapture_opt_out": true,
  "autocapture_exceptions_opt_in": true,
  "autocapture_web_vitals_opt_in": true,
  "autocapture_web_vitals_allowed_metrics": null,
  "autocapture_exceptions_errors_to_ignore": null,
  "capture_console_log_opt_in": true,
  "capture_performance_opt_in": true,
  "session_recording_opt_in": true,
  "session_recording_sample_rate": "string",
  "session_recording_minimum_duration_milliseconds": 30000,
  "session_recording_linked_flag": null,
  "session_recording_network_payload_capture_config": null,
  "session_recording_masking_config": null,
  "session_recording_url_trigger_config": [
    null
  ],
  "session_recording_url_blocklist_config": [
    null
  ],
  "session_recording_event_trigger_config": [
    "string"
  ],
  "session_recording_trigger_match_type_config": "string",
  "session_replay_config": null,
  "survey_config": null,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "flags_persistence_default": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "capture_dead_clicks": true,
  "default_data_theme": -2147483648,
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "goals": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": null,
    "conversion_goals": null
  },
  "onboarding_tasks": null,
  "base_currency": "USD",
  "web_analytics_pre_aggregated_tables_enabled": true,
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "live_events_token": "string",
  "product_intents": "string"
}

Delete environments

Projects for the current organization.

Required API key scopes

project:write

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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

DELETE /api/projects/:project_id/environments/:id

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

Response

Status 204 No response body

Retrieve environments activity

Projects for the current organization.

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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/projects/:project_id/environments/:id/activity

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

Response

Status 200 No response body

Update environments add product intent

Projects for the current organization.

Required API key scopes

team:read

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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
access_control
boolean
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
array
session_recording_url_blocklist_config
array
session_recording_event_trigger_config
array
session_recording_trigger_match_type_config
string
session_replay_config
survey_config
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
cookieless_server_hash_mode
human_friendly_comparison_periods
boolean
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean
flags_persistence_default
boolean
feature_flag_confirmation_enabled
boolean
feature_flag_confirmation_message
string
capture_dead_clicks
boolean
default_data_theme
integer
revenue_analytics_config
marketing_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
boolean

Request

PATCH /api/projects/:project_id/environments/:id/add_product_intent

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/add_product_intent/\
	-d uuid="string"

Response

Status 200 No response body

Update environments complete product onboarding

Projects for the current organization.

Required API key scopes

team:read

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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
access_control
boolean
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
array
session_recording_url_blocklist_config
array
session_recording_event_trigger_config
array
session_recording_trigger_match_type_config
string
session_replay_config
survey_config
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
cookieless_server_hash_mode
human_friendly_comparison_periods
boolean
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean
flags_persistence_default
boolean
feature_flag_confirmation_enabled
boolean
feature_flag_confirmation_message
string
capture_dead_clicks
boolean
default_data_theme
integer
revenue_analytics_config
marketing_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
boolean

Request

PATCH /api/projects/:project_id/environments/:id/complete_product_onboarding

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/complete_product_onboarding/\
	-d uuid="string"

Response

Status 200 No response body

Update environments delete secret token backup

Projects for the current organization.

Path parameters

id
integer
A unique integer value identifying this environment (aka team).
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
access_control
boolean
app_urls
array
slack_incoming_webhook
string
anonymize_ips
boolean
completed_snippet_onboarding
boolean
test_account_filters
test_account_filters_default_checked
boolean
path_cleaning_filters
is_demo
boolean
timezone
data_attributes
person_display_name_properties
array
correlation_config
autocapture_opt_out
boolean
autocapture_exceptions_opt_in
boolean
autocapture_web_vitals_opt_in
boolean
autocapture_web_vitals_allowed_metrics
autocapture_exceptions_errors_to_ignore
capture_console_log_opt_in
boolean
capture_performance_opt_in
boolean
session_recording_opt_in
boolean
session_recording_sample_rate
string
session_recording_minimum_duration_milliseconds
integer
session_recording_linked_flag
session_recording_network_payload_capture_config
session_recording_masking_config
session_recording_url_trigger_config
array
session_recording_url_blocklist_config
array
session_recording_event_trigger_config
array
session_recording_trigger_match_type_config
string
session_replay_config
survey_config
week_start_day
primary_dashboard
integer
live_events_columns
array
recording_domains
array
cookieless_server_hash_mode
human_friendly_comparison_periods
boolean
inject_web_apps
boolean
extra_settings
modifiers
has_completed_onboarding_for
surveys_opt_in
boolean
heatmaps_opt_in
boolean
flags_persistence_default
boolean
feature_flag_confirmation_enabled
boolean
feature_flag_confirmation_message
string
capture_dead_clicks
boolean
default_data_theme
integer
revenue_analytics_config
marketing_analytics_config
onboarding_tasks
base_currency
Default: USD
web_analytics_pre_aggregated_tables_enabled
boolean

Request

PATCH /api/projects/:project_id/environments/:id/delete_secret_token_backup

export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/environments/:id/delete_secret_token_backup/\
	-d uuid="string"