Desktop Persisted API Reference

List all desktop persisted folder

Persisted folders for the desktop product surface. Reuses all PersistedFolderViewSet behaviour but is scoped to the "desktop" surface, so its folders are fully isolated from the default "web" surface.

Required API key scopes

persisted_folder:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/desktop_persisted_folder
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_persisted_folder/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_persisted_folder/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

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",
      "type": "home",
      "protocol": "string",
      "path": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create desktop persisted folder

Persisted folders for the desktop product surface. Reuses all PersistedFolderViewSet behaviour but is scoped to the "desktop" surface, so its folders are fully isolated from the default "web" surface.

Required API key scopes

persisted_folder:write

Request parameters

type
protocol
string
path
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve desktop persisted folder

Persisted folders for the desktop product surface. Reuses all PersistedFolderViewSet behaviour but is scoped to the "desktop" surface, so its folders are fully isolated from the default "web" surface.

Required API key scopes

persisted_folder:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/desktop_persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/desktop_persisted_folder/{desktop_persisted_folder_id}/".format(
        project_id=project_id,
		desktop_persisted_folder_id="<the desktop persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update desktop persisted folder

Persisted folders for the desktop product surface. Reuses all PersistedFolderViewSet behaviour but is scoped to the "desktop" surface, so its folders are fully isolated from the default "web" surface.

Required API key scopes

persisted_folder:write

Path parameters

id
string

Request parameters

type
protocol
string
path
string

Response

Example request

PATCH /api/projects/:project_id/desktop_persisted_folder/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/desktop_persisted_folder/:id/\
	-d type=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/desktop_persisted_folder/{desktop_persisted_folder_id}/".format(
        project_id=project_id,
		desktop_persisted_folder_id="<the desktop persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "home",
  "protocol": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete desktop persisted folder

Persisted folders for the desktop product surface. Reuses all PersistedFolderViewSet behaviour but is scoped to the "desktop" surface, so its folders are fully isolated from the default "web" surface.

Required API key scopes

persisted_folder:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/desktop_persisted_folder/: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/desktop_persisted_folder/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/desktop_persisted_folder/{desktop_persisted_folder_id}/".format(
        project_id=project_id,
		desktop_persisted_folder_id="<the desktop persisted folder id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

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