Error tracking API Reference

Error tracking

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

Endpoints

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

← Previous pageNext page →

Create error tracking issues split

Also available via the PostHog MCP server:
error-tracking-issues-split-create — Split error tracking issue fingerprints

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

fingerprints
array

Response

Example request

POST /api/projects/:project_id/error_tracking/issues/:id/split
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/issues/:id/split/\
	-d fingerprints="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/issues/{error_tracking-3_id}/split/".format(
        project_id=project_id,
		error_tracking-3_id="<the error tracking-3 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"fingerprints": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "success": true,
  "new_issue_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}

Retrieve error tracking issues all activity

Required API key scopes

activity_log:read

Example request

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

Example response

Status 200 No response body

Create error tracking issues bulk

Required API key scopes

error_tracking:write

Request parameters

id
string
status
string
name
stringnull
description
stringnull
first_seen
stringnull
assignee
external_issues
array
cohort

Example request

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

Example response

Status 200 No response body

Retrieve error tracking issues exists

Required API key scopes

error_tracking:read

Example request

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

Example response

Status 200 No response body

Retrieve error tracking issues values

Required API key scopes

error_tracking:read

Example request

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

Example response

Status 200 No response body

Create error tracking query issue

Fetch one error tracking issue with impact counts, top in_app frame, latest release, and optional sparkline.

Required API key scopes

error_tracking:read

Request parameters

issueId
string
dateRange
filterTestAccounts
boolean
Default: true
volumeResolution
integer
Default: 0
includeSparkline
boolean
Default: false

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "status": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "last_seen": "2019-08-24T14:15:22Z",
  "library": "string",
  "source": "string",
  "assignee": {
    "id": "string",
    "type": "string"
  },
  "aggregations": {
    "occurrences": 0.1,
    "users": 0.1,
    "sessions": 0.1,
    "volumeRange": [
      0.1
    ],
    "volume_buckets": [
      {
        "label": "string",
        "value": 0
      }
    ]
  },
  "function": "string",
  "top_in_app_frame": {
    "function": "string",
    "source": "string",
    "line": 0,
    "column": 0,
    "in_app": true
  },
  "latest_release": {
    "version": "string",
    "project": "string",
    "timestamp": "string",
    "commit_id": "string",
    "branch": "string",
    "repo_name": "string"
  },
  "impact": {
    "occurrences": 0.1,
    "users": 0.1,
    "sessions": 0.1
  },
  "sparkline": [
    0.1
  ]
}

Status 404 Issue not found

Create error tracking query issue events

Fetch sampled exception events, stack traces, browser/SDK context, URL, and $session_id values for one issue.

Required API key scopes

error_tracking:read

Request parameters

issueId
string
dateRange
filterTestAccounts
boolean
Default: true
filterGroup
array
searchQuery
string
orderDirection
Default: DESC
limit
integer
Default: 1
offset
integer
Default: 0
include
array
onlyAppFrames
boolean
Default: true

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "uuid": "string",
      "distinct_id": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "properties": {}
    }
  ],
  "hasMore": true,
  "limit": 0,
  "offset": 0,
  "nextOffset": 0
}

Status 404 Issue not found

List all error tracking query issues list

List error tracking issues with typed filters and compact aggregate counts.

Required API key scopes

error_tracking:read

Request parameters

dateRange
status
Default: active
assignee
filterTestAccounts
boolean
Default: true
searchQuery
string
filterGroup
array
orderBy
Default: occurrences
orderDirection
Default: DESC
limit
integer
Default: 25
offset
integer
Default: 0
volumeResolution
integer
Default: 0
library
release
string
fingerprint
user
string
personId
string
url
string
filePath
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "status": "string",
      "first_seen": "2019-08-24T14:15:22Z",
      "last_seen": "2019-08-24T14:15:22Z",
      "library": "string",
      "source": "string",
      "assignee": {
        "id": "string",
        "type": "string"
      },
      "aggregations": {
        "occurrences": 0.1,
        "users": 0.1,
        "sessions": 0.1,
        "volumeRange": [
          0.1
        ],
        "volume_buckets": [
          {
            "label": "string",
            "value": 0
          }
        ]
      }
    }
  ],
  "hasMore": true,
  "limit": 0,
  "offset": 0,
  "nextOffset": 0
}

List all error tracking recommendations

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/error_tracking/recommendations
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/recommendations/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/recommendations/".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",
      "type": "string",
      "meta": null,
      "completed": true,
      "status": "string",
      "computed_at": "2019-08-24T14:15:22Z",
      "dismissed_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking recommendations dismiss

Required API key scopes

error_tracking:write

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "meta": null,
  "completed": true,
  "status": "string",
  "computed_at": "2019-08-24T14:15:22Z",
  "dismissed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Create error tracking recommendations refresh

Required API key scopes

error_tracking:write

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "meta": null,
  "completed": true,
  "status": "string",
  "computed_at": "2019-08-24T14:15:22Z",
  "dismissed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Create error tracking recommendations restore

Required API key scopes

error_tracking:write

Path parameters

id
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "string",
  "meta": null,
  "completed": true,
  "status": "string",
  "computed_at": "2019-08-24T14:15:22Z",
  "dismissed_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

List all error tracking releases

Required API key scopes

error_tracking:read

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/: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/projects/:project_id/error_tracking/releases/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{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": {},
      "version": "string",
      "project": "string"
    }
  ]
}

Create error tracking releases

Required API key scopes

error_tracking:write

Request parameters

version
string
project
string
hash_id
stringnull
metadata
objectnull

Response

Example request

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

Retrieve error tracking releases

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

GET /api/projects/: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/projects/:project_id/error_tracking/releases/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/error_tracking/releases/{error_tracking-3_id}/".format(
        project_id=project_id,
		error_tracking-3_id="<the error tracking-3 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": {},
  "version": "string",
  "project": "string"
}

Update error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

version
stringnull
project
stringnull
hash_id
stringnull
metadata
objectnull

Example request

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

Example response

Status 204 No response body

Delete error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string

Example request

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

Example request

GET /api/projects/: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/projects/: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/projects/{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 settings retrieve settings

Required API key scopes

error_tracking:read

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "project_rate_limit_value": 1,
  "project_rate_limit_bucket_size_minutes": 1,
  "per_issue_rate_limit_value": 1,
  "per_issue_rate_limit_bucket_size_minutes": 1
}

← Previous pageNext page →