Error tracking API Reference

Error tracking

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

Endpoints

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

← Previous pageNext page →

Create environments error tracking symbol sets bulk delete

Required API key scopes

error_tracking:write

Request parameters

ids
array

Example request

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

Example response

Status 200 No response body

Create environments error tracking symbol sets bulk finish upload

Required API key scopes

error_tracking:write

Request parameters

content_hashes
object

Example request

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

Example response

Status 200 No response body

Create environments error tracking symbol sets bulk start upload

Required API key scopes

error_tracking:write

Request parameters

chunk_ids
array
release_id
stringnull
symbol_sets
array
force
boolean
Default: false
skip_on_conflict
boolean
Default: false

Example request

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

Example response

Status 200 No response body

List all error tracking assignment rules

Also available via the PostHog MCP server:
error-tracking-assignment-rules-list — List error tracking assignment rules

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/assignment_rules
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/assignment_rules/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_rules/".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",
      "filters": null,
      "assignee": {
        "type": "user",
        "id": 0
      },
      "order_key": 0,
      "disabled_data": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking assignment rules

Also available via the PostHog MCP server:
error-tracking-assignment-rules-create — Create error tracking assignment rule

Required API key scopes

error_tracking:write

Request parameters

filters
assignee
order_key
integer
Default: 0

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": {
    "type": "user",
    "id": 0
  },
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking assignment rules

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "assignee": {
    "type": "user",
    "id": 0
  },
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

filters
assignee

Example request

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

Example response

Status 204 No response body

Delete error tracking assignment rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Update error tracking assignment rules reorder

Request parameters

filters
order_key
integer
disabled_data

Example request

PATCH /api/projects/:project_id/error_tracking/assignment_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/projects/:project_id/error_tracking/assignment_rules/reorder/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/assignment_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 bypass rules

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/bypass_rules
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/bypass_rules/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_rules/".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",
      "filters": null,
      "order_key": 0,
      "disabled_data": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking bypass rules

Required API key scopes

error_tracking:write

Request parameters

filters

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking bypass rules

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filters": null,
  "order_key": 0,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking bypass rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

filters

Example request

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

Example response

Status 204 No response body

Delete error tracking bypass rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Update error tracking bypass rules reorder

Request parameters

filters
order_key
integer
disabled_data

Example request

PATCH /api/projects/:project_id/error_tracking/bypass_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/projects/:project_id/error_tracking/bypass_rules/reorder/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/bypass_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 external references

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/external_references
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/error_tracking/external_references/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/external_references/".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",
      "integration": {
        "id": 0,
        "kind": "string",
        "display_name": "string"
      },
      "integration_id": 0,
      "config": {
        "property1": "string",
        "property2": "string"
      },
      "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
      "external_url": "string"
    }
  ]
}

Create error tracking external references

Required API key scopes

error_tracking:write

Request parameters

integration_id
integer
config
object
issue
string

Response

Example request

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

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "integration": {
    "id": 0,
    "kind": "string",
    "display_name": "string"
  },
  "integration_id": 0,
  "config": {
    "property1": "string",
    "property2": "string"
  },
  "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
  "external_url": "string"
}

Retrieve error tracking external references

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "integration": {
    "id": 0,
    "kind": "string",
    "display_name": "string"
  },
  "integration_id": 0,
  "config": {
    "property1": "string",
    "property2": "string"
  },
  "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
  "external_url": "string"
}

← Previous pageNext page →