Error API Reference

Error

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

Endpoints

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

List all error tracking releases

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/error_tracking/releases
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/error_tracking/releases/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/".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",
      "hash_id": "string",
      "team_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "metadata": null,
      "version": "string",
      "project": "string"
    }
  ]
}

List all error tracking releases

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/error_tracking/releases
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/error_tracking/releases/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/".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",
      "hash_id": "string",
      "team_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "metadata": null,
      "version": "string",
      "project": "string"
    }
  ]
}

Create error tracking releases

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Create error tracking releases

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Retrieve error tracking releases

Required API key scopes

error_tracking:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Retrieve error tracking releases

Required API key scopes

error_tracking:read

Path parameters

id
string
project_id
string

Response

Example request

GET /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Update error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

Response

Example request

PATCH /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/\
	-d hash_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"hash_id": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Update error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

Response

Example request

PATCH /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/\
	-d hash_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"hash_id": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "hash_id": "string",
  "team_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "metadata": null,
  "version": "string",
  "project": "string"
}

Delete error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Delete error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Example request

DELETE /api/environments/:project_id/error_tracking/releases/: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/error_tracking/releases/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/{error_tracking-4_id}/".format(
        project_id=project_id,
		error_tracking-4_id="<the error tracking-4 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Retrieve error tracking releases hash

Required API key scopes

error_tracking:read

Path parameters

hash_id
string
project_id
string

Example request

GET /api/environments/:project_id/error_tracking/releases/hash/:hash_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/error_tracking/releases/hash/:hash_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/hash/{hash_id}/".format(
        project_id=project_id,
		hash_id="<the hash id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve error tracking releases hash

Required API key scopes

error_tracking:read

Path parameters

hash_id
string
project_id
string

Example request

GET /api/environments/:project_id/error_tracking/releases/hash/:hash_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/error_tracking/releases/hash/:hash_id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/releases/hash/{hash_id}/".format(
        project_id=project_id,
		hash_id="<the hash id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve error tracking spike detection config

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve error tracking spike detection config

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Example request

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

Example response

Status 200 No response body

Update error tracking spike detection config update config

Path parameters

project_id
string

Example request

PATCH /api/environments/:project_id/error_tracking/spike_detection_config/update_config
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/error_tracking/spike_detection_config/update_config/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/spike_detection_config/update_config/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Update error tracking spike detection config update config

Path parameters

project_id
string

Example request

PATCH /api/environments/:project_id/error_tracking/spike_detection_config/update_config
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/error_tracking/spike_detection_config/update_config/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/spike_detection_config/update_config/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

List all error tracking spike events

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/error_tracking/spike_events
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/error_tracking/spike_events/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/spike_events/".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",
      "issue": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "description": "string"
      },
      "detected_at": "2019-08-24T14:15:22Z",
      "computed_baseline": 0.1,
      "current_bucket_value": 0
    }
  ]
}

List all error tracking spike events

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/environments/:project_id/error_tracking/spike_events
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:project_id/error_tracking/spike_events/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/spike_events/".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",
      "issue": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "description": "string"
      },
      "detected_at": "2019-08-24T14:15:22Z",
      "computed_baseline": 0.1,
      "current_bucket_value": 0
    }
  ]
}