Error API Reference

Error

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

Endpoints

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

← Previous page

Delete error tracking suppression rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/error_tracking/suppression_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/suppression_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/suppression_rules/{error_tracking-8_id}/".format(
        project_id=project_id,
		error_tracking-8_id="<the error tracking-8 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Update error tracking suppression rules reorder

Request parameters

filters
order_key
integer
disabled_data
sampling_rate
number

Example request

PATCH /api/projects/:project_id/error_tracking/suppression_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/suppression_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/suppression_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 symbol sets

Also available via the PostHog MCP server:
error-tracking-symbol-sets-list — List error tracking symbol sets

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer
order_by
string
One of: "created_at""-created_at""ref""-ref""last_used""-last_used"
ref
string
search
string
status
string
Default: all
One of: "all""valid""invalid"

Response

Example request

GET /api/projects/:project_id/error_tracking/symbol_sets
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/symbol_sets/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/symbol_sets/".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",
      "ref": "string",
      "team_id": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "last_used": "2019-08-24T14:15:22Z",
      "failure_reason": "string",
      "has_uploaded_file": true,
      "release": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "hash_id": "string",
        "team_id": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "metadata": {},
        "version": "string",
        "project": "string"
      }
    }
  ]
}

Retrieve error tracking symbol sets

Also available via the PostHog MCP server:
error-tracking-symbol-sets-retrieve — Get error tracking symbol set

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

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

Delete error tracking symbol sets

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example response

Status 204 No response body

Retrieve error tracking symbol sets download

Also available via the PostHog MCP server:
error-tracking-symbol-sets-download-retrieve — Download error tracking symbol set

Return a presigned URL for downloading the symbol set's source map.

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "url": "http://example.com"
}

Create error tracking symbol sets bulk delete

Required API key scopes

error_tracking:write

Request parameters

ids
array

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_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 error tracking symbol sets bulk finish upload

Required API key scopes

error_tracking:write

Request parameters

content_hashes
object

Example request

POST /api/projects/:project_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/projects/:project_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/projects/{project_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 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/projects/:project_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/projects/:project_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/projects/{project_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

← Previous page

Error

Endpoints

Delete error tracking suppression rules

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Update error tracking suppression rules reorder

Request parameters

Example request

Example response

Status 200 No response body

List all error tracking symbol sets

Required API key scopes

Query parameters

Response

Example request

Example response

Status 200

Retrieve error tracking symbol sets

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Delete error tracking symbol sets

Required API key scopes

Path parameters

Example request

Example response

Status 204 No response body

Retrieve error tracking symbol sets download

Required API key scopes

Path parameters

Response

Example request

Example response

Status 200

Create error tracking symbol sets bulk delete

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Create error tracking symbol sets bulk finish upload

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Create error tracking symbol sets bulk start upload

Required API key scopes

Request parameters

Example request

Example response

Status 200 No response body

Community questions