Saved API Reference

Saved

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

Endpoints

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

List all environments saved

Required API key scopes

heatmap:read

Path parameters

environment_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:environment_id/saved
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/saved/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/saved/".format(
        project_id=project_id,
		environment_id="<the environment 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",
      "short_id": "string",
      "name": "string",
      "url": "http://example.com",
      "data_url": "http://example.com",
      "target_widths": null,
      "type": "screenshot",
      "status": "processing",
      "has_content": true,
      "snapshots": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "deleted": true,
      "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",
      "updated_at": "2019-08-24T14:15:22Z",
      "exception": "string"
    }
  ]
}

Create environments saved

Required API key scopes

heatmap:write

Path parameters

environment_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Response

Example request

POST /api/environments/:environment_id/saved
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/:environment_id/saved/\
	-d url="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/saved/".format(
        project_id=project_id,
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"url": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Retrieve environments saved

Required API key scopes

heatmap:read

Path parameters

environment_id
string
short_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Update environments saved

Required API key scopes

heatmap:write

Path parameters

environment_id
string
short_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Response

Example request

PATCH /api/environments/:environment_id/saved/:short_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/:environment_id/saved/:short_id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{environment_id}/saved/{short_id}/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Delete environments saved

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

heatmap:write

Path parameters

environment_id
string
short_id
string

Example request

DELETE /api/environments/:environment_id/saved/:short_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/:environment_id/saved/:short_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{environment_id}/saved/{short_id}/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 405 No response body

Create environments saved regenerate

Path parameters

environment_id
string
short_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Example request

POST /api/environments/:environment_id/saved/:short_id/regenerate
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/:environment_id/saved/:short_id/regenerate/\
	-d url="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{environment_id}/saved/{short_id}/regenerate/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"url": "string"
	}
).json()

Example response

Status 200 No response body

List all saved

Required API key scopes

heatmap:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/saved
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/saved/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/saved/".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",
      "short_id": "string",
      "name": "string",
      "url": "http://example.com",
      "data_url": "http://example.com",
      "target_widths": null,
      "type": "screenshot",
      "status": "processing",
      "has_content": true,
      "snapshots": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "deleted": true,
      "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",
      "updated_at": "2019-08-24T14:15:22Z",
      "exception": "string"
    }
  ]
}

Create saved

Required API key scopes

heatmap:write

Path parameters

project_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Retrieve saved

Required API key scopes

heatmap:read

Path parameters

project_id
string
short_id
string

Response

Example request

GET /api/projects/:project_id/saved/:short_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/saved/:short_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/saved/{short_id}/".format(
        project_id=project_id,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Update saved

Required API key scopes

heatmap:write

Path parameters

project_id
string
short_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Response

Example request

PATCH /api/projects/:project_id/saved/:short_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/saved/:short_id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/saved/{short_id}/".format(
        project_id=project_id,
		short_id="<the short id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_id": "string",
  "name": "string",
  "url": "http://example.com",
  "data_url": "http://example.com",
  "target_widths": null,
  "type": "screenshot",
  "status": "processing",
  "has_content": true,
  "snapshots": [
    {
      "property1": null,
      "property2": null
    }
  ],
  "deleted": true,
  "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",
  "updated_at": "2019-08-24T14:15:22Z",
  "exception": "string"
}

Delete saved

Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true

Required API key scopes

heatmap:write

Path parameters

project_id
string
short_id
string

Example request

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

Example response

Status 405 No response body

Create saved regenerate

Path parameters

project_id
string
short_id
string

Request parameters

name
string
url
string
data_url
string
target_widths
type
deleted
boolean

Example request

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