Error API Reference

Error

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

Endpoints

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

← Previous pageNext page →

Retrieve error tracking fingerprints

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

GET /api/environments/:project_id/error_tracking/fingerprints/: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/fingerprints/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/fingerprints/{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",
  "fingerprint": "string",
  "issue_id": "117c70c4-891b-49ba-96f2-b7599e2af0f7",
  "created_at": "2019-08-24T14:15:22Z"
}

Delete error tracking fingerprints

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

Path parameters

id
string

Example request

DELETE /api/environments/:project_id/error_tracking/fingerprints/: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/fingerprints/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/fingerprints/{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 405 No response body

Delete error tracking fingerprints

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

Path parameters

id
string

Example request

DELETE /api/environments/:project_id/error_tracking/fingerprints/: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/fingerprints/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/fingerprints/{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 405 No response body

Retrieve error tracking git provider file links resolve github

Query parameters

code_sample
string
file_name
string
owner
string
repository
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "found": true,
  "url": "string",
  "error": "string"
}

Retrieve error tracking git provider file links resolve github

Query parameters

code_sample
string
file_name
string
owner
string
repository
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "found": true,
  "url": "string",
  "error": "string"
}

Retrieve error tracking git provider file links resolve gitlab

Query parameters

code_sample
string
file_name
string
owner
string
repository
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "found": true,
  "url": "string",
  "error": "string"
}

Retrieve error tracking git provider file links resolve gitlab

Query parameters

code_sample
string
file_name
string
owner
string
repository
string

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "found": true,
  "url": "string",
  "error": "string"
}

List all error tracking grouping rules

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

Required API key scopes

error_tracking:read

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "filters": null,
      "assignee": {
        "type": "user",
        "id": 0
      },
      "description": "string",
      "issue": {
        "property1": "string",
        "property2": "string"
      },
      "order_key": -2147483648,
      "disabled_data": null,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create error tracking grouping rules

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

Required API key scopes

error_tracking:write

Request parameters

filters
assignee
description
stringnull

Response

Example request

POST /api/environments/:project_id/error_tracking/grouping_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/environments/:project_id/error_tracking/grouping_rules/\
	-d filters=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/grouping_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
  },
  "description": "string",
  "issue": {
    "property1": "string",
    "property2": "string"
  },
  "order_key": -2147483648,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve error tracking grouping rules

Required API key scopes

error_tracking:read

Path parameters

id
string

Response

Example request

GET /api/environments/:project_id/error_tracking/grouping_rules/: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/grouping_rules/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{project_id}/error_tracking/grouping_rules/{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",
  "filters": null,
  "assignee": {
    "type": "user",
    "id": 0
  },
  "description": "string",
  "issue": {
    "property1": "string",
    "property2": "string"
  },
  "order_key": -2147483648,
  "disabled_data": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update error tracking grouping rules

Required API key scopes

error_tracking:write

Path parameters

id
string

Request parameters

filters

Example request

PATCH /api/environments/:project_id/error_tracking/grouping_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/environments/:project_id/error_tracking/grouping_rules/:id/\
	-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/{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={}
).json()

Example response

Status 204 No response body

Delete error tracking grouping rules

Required API key scopes

error_tracking:write

Path parameters

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-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

Update error tracking grouping rules reorder

Request parameters

filters
description
stringnull
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

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": 0,
        "type": "string"
      },
      "external_issues": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "integration": {
            "id": 0,
            "kind": "string",
            "display_name": "string"
          },
          "integration_id": 0,
          "config": null,
          "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
          "external_url": "string"
        }
      ],
      "cohort": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

List all error tracking issues

Required API key scopes

error_tracking:read

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": 0,
        "type": "string"
      },
      "external_issues": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "integration": {
            "id": 0,
            "kind": "string",
            "display_name": "string"
          },
          "integration_id": 0,
          "config": null,
          "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
          "external_url": "string"
        }
      ],
      "cohort": {
        "id": 0,
        "name": "string"
      }
    }
  ]
}

Create error tracking issues

Required API key scopes

error_tracking:write

Request parameters

status
name
stringnull
description
stringnull
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": 0,
    "type": "string"
  },
  "external_issues": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "integration": {
        "id": 0,
        "kind": "string",
        "display_name": "string"
      },
      "integration_id": 0,
      "config": null,
      "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
      "external_url": "string"
    }
  ],
  "cohort": {
    "id": 0,
    "name": "string"
  }
}

Create error tracking issues

Required API key scopes

error_tracking:write

Request parameters

status
name
stringnull
description
stringnull
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": 0,
    "type": "string"
  },
  "external_issues": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "integration": {
        "id": 0,
        "kind": "string",
        "display_name": "string"
      },
      "integration_id": 0,
      "config": null,
      "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
      "external_url": "string"
    }
  ],
  "cohort": {
    "id": 0,
    "name": "string"
  }
}

Retrieve error tracking issues

Required API key scopes

error_tracking:read

Path parameters

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-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",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": 0,
    "type": "string"
  },
  "external_issues": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "integration": {
        "id": 0,
        "kind": "string",
        "display_name": "string"
      },
      "integration_id": 0,
      "config": null,
      "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
      "external_url": "string"
    }
  ],
  "cohort": {
    "id": 0,
    "name": "string"
  }
}

Retrieve error tracking issues

Required API key scopes

error_tracking:read

Path parameters

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-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",
  "status": "archived",
  "name": "string",
  "description": "string",
  "first_seen": "2019-08-24T14:15:22Z",
  "assignee": {
    "id": 0,
    "type": "string"
  },
  "external_issues": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "integration": {
        "id": 0,
        "kind": "string",
        "display_name": "string"
      },
      "integration_id": 0,
      "config": null,
      "issue": "984f8aab-1dc8-4804-8ae1-d0944856240b",
      "external_url": "string"
    }
  ],
  "cohort": {
    "id": 0,
    "name": "string"
  }
}

← Previous pageNext page →