Error API Reference

Error

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

Endpoints

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

Delete error tracking grouping rules

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 204 No response body

Update error tracking grouping rules reorder

Path parameters

project_id
string

Request parameters

filters
order_key
integer
disabled_data

Example request

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

Example response

Status 200 No response body

List all error tracking issues

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/issues
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/issues/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/issues/".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",
      "status": "archived",
      "name": "string",
      "description": "string",
      "first_seen": "2019-08-24T14:15:22Z",
      "assignee": {
        "id": "string",
        "type": "string"
      },
      "external_issues": [
        {
          "external_url": "string",
          "id": "string",
          "integration": {
            "display_name": "string",
            "id": 0,
            "kind": "slack"
          }
        }
      ],
      "cohort": "string"
    }
  ]
}

List all error tracking issues

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/issues
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/issues/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/issues/".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",
      "status": "archived",
      "name": "string",
      "description": "string",
      "first_seen": "2019-08-24T14:15:22Z",
      "assignee": {
        "id": "string",
        "type": "string"
      },
      "external_issues": [
        {
          "external_url": "string",
          "id": "string",
          "integration": {
            "display_name": "string",
            "id": 0,
            "kind": "slack"
          }
        }
      ],
      "cohort": "string"
    }
  ]
}

Create error tracking issues

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Create error tracking issues

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Retrieve error tracking issues

Required API key scopes

error_tracking:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Retrieve error tracking issues

Required API key scopes

error_tracking:read

Path parameters

id
string
project_id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Update error tracking issues

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Update error tracking issues

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "external_issues": [
    {
      "external_url": "string",
      "id": "string",
      "integration": {
        "display_name": "string",
        "id": 0,
        "kind": "slack"
      }
    }
  ],
  "cohort": "string"
}

Delete error tracking issues

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

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 405 No response body

Delete error tracking issues

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

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 405 No response body

Retrieve error tracking issues activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve error tracking issues activity retrieve

Required API key scopes

activity_log:read

Path parameters

id
string
project_id
string

Example request

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

Example response

Status 200 No response body

Update error tracking issues assign

Path parameters

id
string
project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Example request

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

Example response

Status 200 No response body

Update error tracking issues assign

Path parameters

id
string
project_id
string

Request parameters

status
name
string
description
string
first_seen
string
assignee
external_issues
array

Example request

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