Projects

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

Endpoints

GET
POST
GET
PATCH
DELETE
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
PATCH
POST
POST
PATCH
Next page →

List all organizations projects

Projects for the current organization.

Required API key scopes

project:read

Query parameters

  • limit
    integer
  • offset
    integer
  • search
    string
  • tags
    string
  • tags_match
    string
    One of: "all""any"

Response


Example request

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

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,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
      "project_id": 0,
      "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,
      "tags": [
        "string"
      ]
    }
  ]
}

Create organizations projects

Projects for the current organization.

Required API key scopes

project:write

Request parameters

  • name
    string
  • product_description
    stringnull
  • tags
    array
  • app_urls
    array
  • anonymize_ips
    boolean
  • completed_snippet_onboarding
    boolean
  • test_account_filters
  • test_account_filters_default_checked
    booleannull
  • path_cleaning_filters
  • is_demo
    boolean
  • timezone
  • data_attributes
  • person_display_name_properties
    arraynull
  • correlation_config
  • autocapture_opt_out
    booleannull
  • autocapture_exceptions_opt_in
    booleannull
  • autocapture_web_vitals_opt_in
    booleannull
  • autocapture_web_vitals_allowed_metrics
  • autocapture_exceptions_errors_to_ignore
  • capture_console_log_opt_in
    booleannull
  • capture_performance_opt_in
    booleannull
  • session_recording_opt_in
    boolean
  • session_recording_sample_rate
    stringnull
  • session_recording_minimum_duration_milliseconds
    integernull
  • session_recording_linked_flag
  • session_recording_network_payload_capture_config
  • session_recording_masking_config
  • session_recording_url_trigger_config
    arraynull
  • session_recording_url_blocklist_config
    arraynull
  • session_recording_event_trigger_config
    arraynull
  • session_recording_trigger_match_type_config
    stringnull
  • session_recording_trigger_groups
  • session_recording_retention_period
  • session_replay_config
  • survey_config
  • access_control
    boolean
  • week_start_day
  • primary_dashboard
    integernull
  • live_events_columns
    arraynull
  • recording_domains
    arraynull
  • inject_web_apps
    booleannull
  • extra_settings
  • modifiers
  • has_completed_onboarding_for
  • surveys_opt_in
    booleannull
  • heatmaps_opt_in
    booleannull
  • flags_persistence_default
    booleannull
  • receive_org_level_activity_logs
    booleannull
  • business_model
  • conversations_enabled
    booleannull
  • conversations_settings
  • logs_settings
  • proactive_tasks_enabled
    booleannull
  • revenue_analytics_config
  • marketing_analytics_config
  • customer_analytics_config
  • workflows_config
  • feature_flag_policy_config
  • base_currency
  • capture_dead_clicks
    booleannull
  • cookieless_server_hash_mode
  • human_friendly_comparison_periods
    booleannull
  • feature_flag_confirmation_enabled
    booleannull
  • feature_flag_confirmation_message
    stringnull
  • default_evaluation_contexts_enabled
    booleannull
  • require_evaluation_contexts
    booleannull
  • default_data_theme
    integernull
  • onboarding_tasks
  • web_analytics_pre_aggregated_tables_enabled
    booleannull

Response


Example request

POST /api/organizations/:organization_id/projects
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/organizations/:organization_id/projects/\
	-d organization="string"

Example response

Status 201
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Retrieve organizations projects

Retrieve a project and its settings.

Required API key scopes

project:read

Path parameters

  • id
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Update organizations projects

Update one or more of a project's settings. Only the fields included in the request body are changed.

Required API key scopes

project:write

Path parameters

  • id
    integer

Request parameters

  • name
    string
  • product_description
    stringnull
  • tags
    array
  • app_urls
    array
  • anonymize_ips
    boolean
  • completed_snippet_onboarding
    boolean
  • test_account_filters
  • test_account_filters_default_checked
    booleannull
  • path_cleaning_filters
  • is_demo
    boolean
  • timezone
  • data_attributes
  • person_display_name_properties
    arraynull
  • correlation_config
  • autocapture_opt_out
    booleannull
  • autocapture_exceptions_opt_in
    booleannull
  • autocapture_web_vitals_opt_in
    booleannull
  • autocapture_web_vitals_allowed_metrics
  • autocapture_exceptions_errors_to_ignore
  • capture_console_log_opt_in
    booleannull
  • capture_performance_opt_in
    booleannull
  • session_recording_opt_in
    boolean
  • session_recording_sample_rate
    stringnull
  • session_recording_minimum_duration_milliseconds
    integernull
  • session_recording_linked_flag
  • session_recording_network_payload_capture_config
  • session_recording_masking_config
  • session_recording_url_trigger_config
    arraynull
  • session_recording_url_blocklist_config
    arraynull
  • session_recording_event_trigger_config
    arraynull
  • session_recording_trigger_match_type_config
    stringnull
  • session_recording_trigger_groups
  • session_recording_retention_period
  • session_replay_config
  • survey_config
  • access_control
    boolean
  • week_start_day
  • primary_dashboard
    integernull
  • live_events_columns
    arraynull
  • recording_domains
    arraynull
  • inject_web_apps
    booleannull
  • extra_settings
  • modifiers
  • has_completed_onboarding_for
  • surveys_opt_in
    booleannull
  • heatmaps_opt_in
    booleannull
  • flags_persistence_default
    booleannull
  • receive_org_level_activity_logs
    booleannull
  • business_model
  • conversations_enabled
    booleannull
  • conversations_settings
  • logs_settings
  • proactive_tasks_enabled
    booleannull
  • revenue_analytics_config
  • marketing_analytics_config
  • customer_analytics_config
  • workflows_config
  • feature_flag_policy_config
  • base_currency
  • capture_dead_clicks
    booleannull
  • cookieless_server_hash_mode
  • human_friendly_comparison_periods
    booleannull
  • feature_flag_confirmation_enabled
    booleannull
  • feature_flag_confirmation_message
    stringnull
  • default_evaluation_contexts_enabled
    booleannull
  • require_evaluation_contexts
    booleannull
  • default_data_theme
    integernull
  • onboarding_tasks
  • web_analytics_pre_aggregated_tables_enabled
    booleannull

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Delete organizations projects

Projects for the current organization.

Required API key scopes

project:write

Path parameters

  • id
    integer

Example request

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

Example response

Status 204 No response body

Retrieve organizations projects access control default objects

Object rules that apply to everyone in the project without a rule of their own on that object.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "resource": "string",
      "resource_id": "string",
      "name": "string",
      "short_id": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control default properties

Property rules that apply to everyone in the project without a rule of their own on that property.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "property_definition_id": "73b88124-586a-4ae3-bb4b-246f06c7f87f",
      "property": "string",
      "property_type": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control defaults

The project's default access. Returns the level that applies to the project and to each resource type when a member or a role has no rule of their own. Also lists the resource types that accept rules on single objects, with the levels such a rule can set.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "available_project_levels": [
    "string"
  ],
  "available_resource_levels": [
    "string"
  ],
  "can_edit": true,
  "project_access_level": "string",
  "resource_access_levels": {
    "property1": {
      "access_level": "string",
      "minimum": "string",
      "maximum": "string"
    },
    "property2": {
      "access_level": "string",
      "minimum": "string",
      "maximum": "string"
    }
  },
  "object_rule_resources": [
    {
      "resource": "string",
      "available_access_levels": [
        "string"
      ],
      "minimum_access_level": "string"
    }
  ]
}

Retrieve organizations projects access control member objects

Object rules configured for a member: the single objects, for example a dashboard or a notebook, the member is granted or denied, regardless of the resource-level rules.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • member_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "resource": "string",
      "resource_id": "string",
      "name": "string",
      "short_id": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control member properties

Property rules configured for a member: the person and event properties the member can read, read and write, or not see.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • member_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "property_definition_id": "73b88124-586a-4ae3-bb4b-246f06c7f87f",
      "property": "string",
      "property_type": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control members

Every organization member's access in this project. For the project and for each resource type, the response gives the member's own rule and the level that is enforced. It also says where the enforced level comes from: the member's rule, a role's rule, the project default, or full access as an organization admin. Pass member_id for one member.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • member_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "available_project_levels": [
    "string"
  ],
  "available_resource_levels": [
    "string"
  ],
  "can_edit": true,
  "results": [
    {
      "organization_membership_id": "36a5127e-4d6e-4b4e-93ab-c14c6bbfd8ff",
      "user": {
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com"
      },
      "organization_level": 1,
      "role_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "project": {
        "access_level": "string",
        "effective_access_level": "string",
        "inherited_access": {
          "access_level": "string",
          "source": "object",
          "source_subject": "member",
          "source_resource": "string",
          "source_resource_id": "string"
        },
        "minimum": "string",
        "maximum": "string"
      },
      "resources": {
        "property1": {
          "access_level": "string",
          "effective_access_level": "string",
          "inherited_access": {
            "access_level": "string",
            "source": "object",
            "source_subject": "member",
            "source_resource": "string",
            "source_resource_id": "string"
          },
          "minimum": "string",
          "maximum": "string"
        },
        "property2": {
          "access_level": "string",
          "effective_access_level": "string",
          "inherited_access": {
            "access_level": "string",
            "source": "object",
            "source_subject": "member",
            "source_resource": "string",
            "source_resource_id": "string"
          },
          "minimum": "string",
          "maximum": "string"
        }
      }
    }
  ]
}

Retrieve organizations projects access control role objects

Object rules configured for a role: the single objects the role's members are granted or denied, regardless of the resource-level rules.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • role_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "resource": "string",
      "resource_id": "string",
      "name": "string",
      "short_id": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control role properties

Property rules configured for a role: the person and event properties the role's members can read, read and write, or not see.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • role_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "results": [
    {
      "property_definition_id": "73b88124-586a-4ae3-bb4b-246f06c7f87f",
      "property": "string",
      "property_type": "string",
      "access_level": "string"
    }
  ]
}

Retrieve organizations projects access control roles

Every role's resolved access to this project and to each resource type in it: the role's own rule, the level that is enforced, and the rule the enforced level comes from. Pass role_id for one role.

Required API key scopes

access_control:read

Path parameters

  • id
    integer

Query parameters

  • role_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "available_project_levels": [
    "string"
  ],
  "available_resource_levels": [
    "string"
  ],
  "can_edit": true,
  "results": [
    {
      "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
      "role_name": "string",
      "project": {
        "access_level": "string",
        "effective_access_level": "string",
        "inherited_access": {
          "access_level": "string",
          "source": "object",
          "source_subject": "member",
          "source_resource": "string",
          "source_resource_id": "string"
        },
        "minimum": "string",
        "maximum": "string"
      },
      "resources": {
        "property1": {
          "access_level": "string",
          "effective_access_level": "string",
          "inherited_access": {
            "access_level": "string",
            "source": "object",
            "source_subject": "member",
            "source_resource": "string",
            "source_resource_id": "string"
          },
          "minimum": "string",
          "maximum": "string"
        },
        "property2": {
          "access_level": "string",
          "effective_access_level": "string",
          "inherited_access": {
            "access_level": "string",
            "source": "object",
            "source_subject": "member",
            "source_resource": "string",
            "source_resource_id": "string"
          },
          "minimum": "string",
          "maximum": "string"
        }
      }
    }
  ]
}

Retrieve organizations projects activity

Projects for the current organization.

Path parameters

  • id
    integer

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Update organizations projects add product intent

Projects for the current organization.

Required API key scopes

project:read

Path parameters

  • id
    integer

Request parameters

  • name
    string
  • product_description
    stringnull
  • tags
    array
  • app_urls
    array
  • anonymize_ips
    boolean
  • completed_snippet_onboarding
    boolean
  • test_account_filters
  • test_account_filters_default_checked
    booleannull
  • path_cleaning_filters
  • is_demo
    boolean
  • timezone
  • data_attributes
  • person_display_name_properties
    arraynull
  • correlation_config
  • autocapture_opt_out
    booleannull
  • autocapture_exceptions_opt_in
    booleannull
  • autocapture_web_vitals_opt_in
    booleannull
  • autocapture_web_vitals_allowed_metrics
  • autocapture_exceptions_errors_to_ignore
  • capture_console_log_opt_in
    booleannull
  • capture_performance_opt_in
    booleannull
  • session_recording_opt_in
    boolean
  • session_recording_sample_rate
    stringnull
  • session_recording_minimum_duration_milliseconds
    integernull
  • session_recording_linked_flag
  • session_recording_network_payload_capture_config
  • session_recording_masking_config
  • session_recording_url_trigger_config
    arraynull
  • session_recording_url_blocklist_config
    arraynull
  • session_recording_event_trigger_config
    arraynull
  • session_recording_trigger_match_type_config
    stringnull
  • session_recording_trigger_groups
  • session_recording_retention_period
  • session_replay_config
  • survey_config
  • access_control
    boolean
  • week_start_day
  • primary_dashboard
    integernull
  • live_events_columns
    arraynull
  • recording_domains
    arraynull
  • inject_web_apps
    booleannull
  • extra_settings
  • modifiers
  • has_completed_onboarding_for
  • surveys_opt_in
    booleannull
  • heatmaps_opt_in
    booleannull
  • flags_persistence_default
    booleannull
  • receive_org_level_activity_logs
    booleannull
  • business_model
  • conversations_enabled
    booleannull
  • conversations_settings
  • logs_settings
  • proactive_tasks_enabled
    booleannull
  • revenue_analytics_config
  • marketing_analytics_config
  • customer_analytics_config
  • workflows_config
  • feature_flag_policy_config
  • base_currency
  • capture_dead_clicks
    booleannull
  • cookieless_server_hash_mode
  • human_friendly_comparison_periods
    booleannull
  • feature_flag_confirmation_enabled
    booleannull
  • feature_flag_confirmation_message
    stringnull
  • default_evaluation_contexts_enabled
    booleannull
  • require_evaluation_contexts
    booleannull
  • default_data_theme
    integernull
  • onboarding_tasks
  • web_analytics_pre_aggregated_tables_enabled
    booleannull

Response


Example request

PATCH /api/organizations/:organization_id/projects/: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/organizations/:organization_id/projects/:id/add_product_intent/\
	-d organization="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Create organizations projects cancel deletion

Cancel a scheduled project deletion and restore access to the project.

Path parameters

  • id
    integer

Response


Example request

POST /api/organizations/:organization_id/projects/:id/cancel-deletion
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/organizations/:organization_id/projects/:id/cancel-deletion/

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "name": "string",
  "product_description": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "tags": [
    "string"
  ]
}

Create organizations projects change organization

Projects for the current organization.

Path parameters

  • id
    integer

Request parameters

  • name
    string
  • product_description
    stringnull
  • tags
    array
  • app_urls
    array
  • anonymize_ips
    boolean
  • completed_snippet_onboarding
    boolean
  • test_account_filters
  • test_account_filters_default_checked
    booleannull
  • path_cleaning_filters
  • is_demo
    boolean
  • timezone
  • data_attributes
  • person_display_name_properties
    arraynull
  • correlation_config
  • autocapture_opt_out
    booleannull
  • autocapture_exceptions_opt_in
    booleannull
  • autocapture_web_vitals_opt_in
    booleannull
  • autocapture_web_vitals_allowed_metrics
  • autocapture_exceptions_errors_to_ignore
  • capture_console_log_opt_in
    booleannull
  • capture_performance_opt_in
    booleannull
  • session_recording_opt_in
    boolean
  • session_recording_sample_rate
    stringnull
  • session_recording_minimum_duration_milliseconds
    integernull
  • session_recording_linked_flag
  • session_recording_network_payload_capture_config
  • session_recording_masking_config
  • session_recording_url_trigger_config
    arraynull
  • session_recording_url_blocklist_config
    arraynull
  • session_recording_event_trigger_config
    arraynull
  • session_recording_trigger_match_type_config
    stringnull
  • session_recording_trigger_groups
  • session_recording_retention_period
  • session_replay_config
  • survey_config
  • access_control
    boolean
  • week_start_day
  • primary_dashboard
    integernull
  • live_events_columns
    arraynull
  • recording_domains
    arraynull
  • inject_web_apps
    booleannull
  • extra_settings
  • modifiers
  • has_completed_onboarding_for
  • surveys_opt_in
    booleannull
  • heatmaps_opt_in
    booleannull
  • flags_persistence_default
    booleannull
  • receive_org_level_activity_logs
    booleannull
  • business_model
  • conversations_enabled
    booleannull
  • conversations_settings
  • logs_settings
  • proactive_tasks_enabled
    booleannull
  • revenue_analytics_config
  • marketing_analytics_config
  • customer_analytics_config
  • workflows_config
  • feature_flag_policy_config
  • base_currency
  • capture_dead_clicks
    booleannull
  • cookieless_server_hash_mode
  • human_friendly_comparison_periods
    booleannull
  • feature_flag_confirmation_enabled
    booleannull
  • feature_flag_confirmation_message
    stringnull
  • default_evaluation_contexts_enabled
    booleannull
  • require_evaluation_contexts
    booleannull
  • default_data_theme
    integernull
  • onboarding_tasks
  • web_analytics_pre_aggregated_tables_enabled
    booleannull

Response


Example request

POST /api/organizations/:organization_id/projects/:id/change_organization
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/organizations/:organization_id/projects/:id/change_organization/\
	-d organization="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}

Update organizations projects complete product onboarding

Projects for the current organization.

Required API key scopes

project:read

Path parameters

  • id
    integer

Request parameters

  • name
    string
  • product_description
    stringnull
  • tags
    array
  • app_urls
    array
  • anonymize_ips
    boolean
  • completed_snippet_onboarding
    boolean
  • test_account_filters
  • test_account_filters_default_checked
    booleannull
  • path_cleaning_filters
  • is_demo
    boolean
  • timezone
  • data_attributes
  • person_display_name_properties
    arraynull
  • correlation_config
  • autocapture_opt_out
    booleannull
  • autocapture_exceptions_opt_in
    booleannull
  • autocapture_web_vitals_opt_in
    booleannull
  • autocapture_web_vitals_allowed_metrics
  • autocapture_exceptions_errors_to_ignore
  • capture_console_log_opt_in
    booleannull
  • capture_performance_opt_in
    booleannull
  • session_recording_opt_in
    boolean
  • session_recording_sample_rate
    stringnull
  • session_recording_minimum_duration_milliseconds
    integernull
  • session_recording_linked_flag
  • session_recording_network_payload_capture_config
  • session_recording_masking_config
  • session_recording_url_trigger_config
    arraynull
  • session_recording_url_blocklist_config
    arraynull
  • session_recording_event_trigger_config
    arraynull
  • session_recording_trigger_match_type_config
    stringnull
  • session_recording_trigger_groups
  • session_recording_retention_period
  • session_replay_config
  • survey_config
  • access_control
    boolean
  • week_start_day
  • primary_dashboard
    integernull
  • live_events_columns
    arraynull
  • recording_domains
    arraynull
  • inject_web_apps
    booleannull
  • extra_settings
  • modifiers
  • has_completed_onboarding_for
  • surveys_opt_in
    booleannull
  • heatmaps_opt_in
    booleannull
  • flags_persistence_default
    booleannull
  • receive_org_level_activity_logs
    booleannull
  • business_model
  • conversations_enabled
    booleannull
  • conversations_settings
  • logs_settings
  • proactive_tasks_enabled
    booleannull
  • revenue_analytics_config
  • marketing_analytics_config
  • customer_analytics_config
  • workflows_config
  • feature_flag_policy_config
  • base_currency
  • capture_dead_clicks
    booleannull
  • cookieless_server_hash_mode
  • human_friendly_comparison_periods
    booleannull
  • feature_flag_confirmation_enabled
    booleannull
  • feature_flag_confirmation_message
    stringnull
  • default_evaluation_contexts_enabled
    booleannull
  • require_evaluation_contexts
    booleannull
  • default_data_theme
    integernull
  • onboarding_tasks
  • web_analytics_pre_aggregated_tables_enabled
    booleannull

Response


Example request

PATCH /api/organizations/:organization_id/projects/: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/organizations/:organization_id/projects/:id/complete_product_onboarding/\
	-d organization="string"

Example response

Status 200
RESPONSE
{
  "id": 0,
  "organization": "452c1a86-a0af-475b-b03f-724878b0f387",
  "name": "string",
  "product_description": "string",
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "effective_membership_level": 1,
  "has_group_types": true,
  "group_types": [
    {}
  ],
  "live_events_token": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "api_token": "string",
  "app_urls": [
    "string"
  ],
  "anonymize_ips": true,
  "completed_snippet_onboarding": true,
  "ingested_event": 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_recording_trigger_groups": null,
  "session_recording_retention_period": "30d",
  "session_replay_config": null,
  "survey_config": null,
  "access_control": true,
  "week_start_day": 0,
  "primary_dashboard": 0,
  "live_events_columns": [
    "string"
  ],
  "recording_domains": [
    "string"
  ],
  "person_on_events_querying_enabled": true,
  "inject_web_apps": true,
  "extra_settings": null,
  "modifiers": null,
  "default_modifiers": {},
  "has_completed_onboarding_for": null,
  "surveys_opt_in": true,
  "heatmaps_opt_in": true,
  "product_intents": [
    {
      "product_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "onboarding_completed_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "flags_persistence_default": true,
  "secret_api_token": "string",
  "secret_api_token_backup": "string",
  "heatmaps_screenshot_secret": "string",
  "receive_org_level_activity_logs": true,
  "business_model": "b2b",
  "conversations_enabled": true,
  "conversations_settings": null,
  "logs_settings": null,
  "proactive_tasks_enabled": true,
  "available_setup_task_ids": [
    "ingest_first_event"
  ],
  "is_pending_deletion": true,
  "deletion_scheduled_at": "2019-08-24T14:15:22Z",
  "project_id": 0,
  "user_access_level": "string",
  "managed_viewsets": {
    "property1": true,
    "property2": true
  },
  "revenue_analytics_config": {
    "base_currency": "AED",
    "events": null,
    "filter_test_accounts": true
  },
  "marketing_analytics_config": {
    "sources_map": {
      "property1": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      },
      "property2": {
        "ad_group_id": null,
        "ad_group_name": null,
        "ad_id": null,
        "ad_name": null,
        "campaign": null,
        "clicks": null,
        "cost": null,
        "currency": null,
        "date": null,
        "id": null,
        "impressions": null,
        "reported_conversion": null,
        "reported_conversion_value": null,
        "source": null
      }
    },
    "conversion_goals": [
      {
        "conversion_goal_id": "string",
        "conversion_goal_name": "string",
        "counts_as_customer": null,
        "counts_as_revenue": null,
        "custom_name": null,
        "event": null,
        "kind": "EventsNode",
        "limit": null,
        "math": null,
        "math_group_type_index": null,
        "math_hogql": null,
        "math_multiplier": null,
        "math_property": null,
        "math_property_revenue_currency": null,
        "math_property_type": null,
        "name": "string",
        "optionalInFunnel": null,
        "orderBy": null,
        "properties": null,
        "response": null,
        "schema_map": {
          "property1": "string",
          "property2": "string"
        },
        "version": null
      }
    ],
    "attribution_window_days": 1,
    "attribution_mode": "first_touch",
    "filter_test_accounts": true,
    "campaign_name_mappings": {
      "property1": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "property2": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      }
    },
    "custom_source_mappings": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    },
    "campaign_field_preferences": {
      "property1": {
        "match_field": "campaign_name"
      },
      "property2": {
        "match_field": "campaign_name"
      }
    }
  },
  "customer_analytics_config": {
    "activity_event": null,
    "signup_pageview_event": null,
    "signup_event": null,
    "subscription_event": null,
    "payment_event": null,
    "account_group_type_index": 0
  },
  "workflows_config": {
    "capture_workflows_engagement_events": true,
    "email_tracking_consent_mode": "off",
    "workflow_task_rate_limit_per_day": 0,
    "workflow_task_team_rate_limit_per_day": 0
  },
  "feature_flag_policy_config": {
    "require_tags": true
  },
  "base_currency": "AED",
  "capture_dead_clicks": true,
  "cookieless_server_hash_mode": 0,
  "human_friendly_comparison_periods": true,
  "feature_flag_confirmation_enabled": true,
  "feature_flag_confirmation_message": "string",
  "default_evaluation_contexts_enabled": true,
  "require_evaluation_contexts": true,
  "default_data_theme": -2147483648,
  "onboarding_tasks": null,
  "web_analytics_pre_aggregated_tables_enabled": true
}
Next page →