Core-10

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

Endpoints

POST
POST
POST
GET
POST
POST
GET
GET
POST
GET
POST
GET
GET
GET
GET
POST
GET
POST
DELETE
POST

Create file system link

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

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

Example response

Status 200 No response body

Create file system move

Path parameters

  • id
    string
  • project_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

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

Example response

Status 200 No response body

Create file system count by path

Get count of all files in a folder.

Path parameters

  • project_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/projects/:project_id/file_system/count_by_path
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/file_system/count_by_path/\
	-d path="string"

Example response

Status 200 No response body

Retrieve file system log view

Path parameters

  • project_id
    string

Example request

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

Example response

Status 200 No response body

Create file system log view

Path parameters

  • project_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/projects/:project_id/file_system/log_view
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/file_system/log_view/\
	-d path="string"

Example response

Status 200 No response body

Create file system undo delete

Path parameters

  • project_id
    string

Request parameters

  • path
    string
  • type
    string
  • ref
    string
  • href
    string
  • meta
  • shortcut
    boolean

Example request

POST /api/projects/:project_id/file_system/undo_delete
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/file_system/undo_delete/\
	-d path="string"

Example response

Status 200 No response body

Retrieve file system unfiled

Path parameters

  • project_id
    string

Example request

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

Example response

Status 200 No response body

List all groups

List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/

Required API key scopes

group:read

Path parameters

  • project_id
    string

Query parameters

  • cursor
    string
  • group_type_index
    integer
  • search
    string

Response


Example request

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

Example response

Status 200
RESPONSE
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "group_type_index": -2147483648,
      "group_key": "string",
      "group_properties": null,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create groups

Required API key scopes

group:write

Path parameters

  • project_id
    string

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Response


Example request

POST /api/projects/:project_id/groups
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 201
RESPONSE
{
  "group_type_index": -2147483648,
  "group_key": "string",
  "group_properties": null,
  "created_at": "2019-08-24T14:15:22Z"
}

Retrieve groups activity

Required API key scopes

activity_log:read

Path parameters

  • project_id
    string

Query parameters

  • group_type_index
    integer
  • id
    string

Example request

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

Example response

Status 200 No response body

Create groups delete property

Required API key scopes

group:write

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/projects/:project_id/groups/delete_property
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/delete_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 200 No response body

Retrieve groups find

Required API key scopes

group:read

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Example request

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

Example response

Status 200 No response body

Retrieve groups property definitions

Required API key scopes

group:read

Path parameters

  • project_id
    string

Example request

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

Example response

Status 200 No response body

Retrieve groups property values

Required API key scopes

group:read

Path parameters

  • project_id
    string

Example request

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

Example response

Status 200 No response body

Create groups update property

Required API key scopes

group:write

Path parameters

  • project_id
    string

Query parameters

  • group_key
    string
  • group_type_index
    integer

Request parameters

  • group_type_index
    integer
  • group_key
    string
  • group_properties

Example request

POST /api/projects/:project_id/groups/update_property
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/groups/update_property/\
	-d group_type_index="integer",\
	-d group_key="string"

Example response

Status 200 No response body

List all insights sharing

Required API key scopes

sharing_configuration:read

Path parameters

  • insight_id
    integer
  • project_id
    string

Example request

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

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Create insights sharing passwords

Create a new password for the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/passwords
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/passwords/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}

Delete insights sharing passwords

Delete a password from the sharing configuration.

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • password_id
    string
  • project_id
    string

Example request

DELETE /api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_id/

Example response

Status 204 No response body

Create insights sharing refresh

Required API key scopes

sharing_configuration:write

Path parameters

  • insight_id
    integer
  • project_id
    string

Request parameters

  • enabled
    boolean
  • settings
  • password_required
    boolean

Response


Example request

POST /api/projects/:project_id/insights/:insight_id/sharing/refresh
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/insights/:insight_id/sharing/refresh/\
	-d created_at="string"

Example response

Status 200
RESPONSE
{
  "created_at": "2019-08-24T14:15:22Z",
  "enabled": true,
  "access_token": "string",
  "settings": null,
  "password_required": true,
  "share_passwords": "string"
}
Next page →

Community questions

Questions about this page? or post a community question.