Environments-25

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

Endpoints

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

Retrieve environments warehouse saved queries

Required API key scopes

warehouse_view:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Update environments warehouse saved queries

Required API key scopes

warehouse_view:write

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Delete environments warehouse saved queries

Required API key scopes

warehouse_view:write

Path parameters

  • id
    string
  • project_id
    string

Example request

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

Example response

Status 204 No response body

Retrieve environments warehouse saved queries activity

Required API key scopes

activity_log:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries ancestors

Return the ancestors of this saved query.

By default, we return the immediate parents. The level parameter can be used to look further back into the ancestor tree. If level overshoots (i.e. points to only ancestors beyond the root), we return an empty list.

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/ancestors
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_saved_queries/:id/ancestors/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries cancel

Cancel a running saved query workflow.

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/cancel
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/warehouse_saved_queries/:id/cancel/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Retrieve environments warehouse saved queries dependencies

Return the count of immediate upstream and downstream dependencies for this saved query.

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries descendants

Return the descendants of this saved query.

By default, we return the immediate children. The level parameter can be used to look further ahead into the descendants tree. If level overshoots (i.e. points to only descendants further than a leaf), we return an empty list.

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/descendants
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_saved_queries/:id/descendants/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries materialize

Enable materialization for this saved query with a 24-hour sync frequency.

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/materialize
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_saved_queries/:id/materialize/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries revert materialization

Undo materialization, revert back to the original view. (i.e. delete the materialized table and the schedule)

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/revert_materialization
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_saved_queries/:id/revert_materialization/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries run

Run this saved query.

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/:id/run
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_saved_queries/:id/run/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Retrieve environments warehouse saved queries run history

Return the recent run history (up to 5 most recent) for this materialized view.

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

Create environments warehouse saved queries resume schedules

Resume paused materialization schedules for multiple matviews.

Accepts a list of view IDs in the request body: {"view_ids": ["id1", "id2", ...]} This endpoint is idempotent - calling it on already running or non-existent schedules is safe.

Path parameters

  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • query
  • edited_history_id
    string
  • soft_update
    boolean

Response


Example request

POST /api/environments/:project_id/warehouse_saved_queries/resume_schedules
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_saved_queries/resume_schedules/\
	-d name="string"

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "query": null,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "sync_frequency": "string",
  "columns": "string",
  "status": "Cancelled",
  "last_run_at": "2019-08-24T14:15:22Z",
  "managed_viewset_kind": "string",
  "latest_error": "string",
  "edited_history_id": "string",
  "latest_history_id": "string",
  "soft_update": true,
  "is_materialized": true,
  "origin": "data_warehouse"
}

List all environments warehouse tables

Required API key scopes

warehouse_table:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer
  • search
    string

Response


Example request

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "deleted": true,
      "name": "string",
      "format": "CSV",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "url_pattern": "string",
      "credential": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_by": {
          "id": 0,
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "distinct_id": "string",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "is_email_verified": true,
          "hedgehog_config": {
            "property1": null,
            "property2": null
          },
          "role_at_organization": "engineering"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "access_key": "string",
        "access_secret": "string"
      },
      "columns": "string",
      "external_data_source": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_at": "2019-08-24T14:15:22Z",
        "created_by": 0,
        "status": "string",
        "source_type": "Ashby"
      },
      "external_schema": "string"
    }
  ]
}

List all environments warehouse tables

Required API key scopes

warehouse_table:read

Path parameters

  • project_id
    string

Query parameters

  • limit
    integer
  • offset
    integer
  • search
    string

Response


Example request

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

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": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "deleted": true,
      "name": "string",
      "format": "CSV",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {
          "property1": null,
          "property2": null
        },
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "url_pattern": "string",
      "credential": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_by": {
          "id": 0,
          "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
          "distinct_id": "string",
          "first_name": "string",
          "last_name": "string",
          "email": "user@example.com",
          "is_email_verified": true,
          "hedgehog_config": {
            "property1": null,
            "property2": null
          },
          "role_at_organization": "engineering"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "access_key": "string",
        "access_secret": "string"
      },
      "columns": "string",
      "external_data_source": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "created_at": "2019-08-24T14:15:22Z",
        "created_by": 0,
        "status": "string",
        "source_type": "Ashby"
      },
      "external_schema": "string"
    }
  ]
}

Create environments warehouse tables

Required API key scopes

warehouse_table:write

Path parameters

  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • format
  • url_pattern
    string
  • credential

Response


Example request

POST /api/environments/:project_id/warehouse_tables
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/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "format": "CSV",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "url_pattern": "string",
  "credential": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {
        "property1": null,
        "property2": null
      },
      "role_at_organization": "engineering"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "access_key": "string",
    "access_secret": "string"
  },
  "columns": "string",
  "external_data_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "status": "string",
    "source_type": "Ashby"
  },
  "external_schema": "string"
}

Create environments warehouse tables

Required API key scopes

warehouse_table:write

Path parameters

  • project_id
    string

Request parameters

  • deleted
    boolean
  • name
    string
  • format
  • url_pattern
    string
  • credential

Response


Example request

POST /api/environments/:project_id/warehouse_tables
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/\
	-d name="string",\
	-d format=undefined,\
	-d url_pattern="string",\
	-d credential=undefined

Example response

Status 201
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "format": "CSV",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "url_pattern": "string",
  "credential": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {
        "property1": null,
        "property2": null
      },
      "role_at_organization": "engineering"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "access_key": "string",
    "access_secret": "string"
  },
  "columns": "string",
  "external_data_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "status": "string",
    "source_type": "Ashby"
  },
  "external_schema": "string"
}

Retrieve environments warehouse tables

Required API key scopes

warehouse_table:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "format": "CSV",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "url_pattern": "string",
  "credential": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {
        "property1": null,
        "property2": null
      },
      "role_at_organization": "engineering"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "access_key": "string",
    "access_secret": "string"
  },
  "columns": "string",
  "external_data_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "status": "string",
    "source_type": "Ashby"
  },
  "external_schema": "string"
}

Retrieve environments warehouse tables

Required API key scopes

warehouse_table:read

Path parameters

  • id
    string
  • project_id
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "deleted": true,
  "name": "string",
  "format": "CSV",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {
      "property1": null,
      "property2": null
    },
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "url_pattern": "string",
  "credential": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_by": {
      "id": 0,
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "distinct_id": "string",
      "first_name": "string",
      "last_name": "string",
      "email": "user@example.com",
      "is_email_verified": true,
      "hedgehog_config": {
        "property1": null,
        "property2": null
      },
      "role_at_organization": "engineering"
    },
    "created_at": "2019-08-24T14:15:22Z",
    "access_key": "string",
    "access_secret": "string"
  },
  "columns": "string",
  "external_data_source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "status": "string",
    "source_type": "Ashby"
  },
  "external_schema": "string"
}
Next page →

Community questions

Questions about this page? or post a community question.