Error API Reference

Error

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

Endpoints

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

List all error tracking releases

Required API key scopes

error_tracking:read

Path parameters

project_id
string

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/

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": null,
      "version": "string",
      "project": "string"
    }
  ]
}

Create error tracking releases

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

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 hash_id="string",\
	-d version="string",\
	-d project="string"

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": null,
  "version": "string",
  "project": "string"
}

Retrieve error tracking releases

Required API key scopes

error_tracking:read

Path parameters

id
string
project_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/

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": null,
  "version": "string",
  "project": "string"
}

Update error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_id
string

Request parameters

hash_id
string
metadata
version
string
project
string

Response

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 hash_id="string"

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": null,
  "version": "string",
  "project": "string"
}

Delete error tracking releases

Required API key scopes

error_tracking:write

Path parameters

id
string
project_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/

Example response

Status 204 No response body

Retrieve error tracking releases hash

Required API key scopes

error_tracking:read

Path parameters

hash_id
string
project_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/

Example response

Status 200 No response body

List all error tracking symbol sets

Required API key scopes

error_tracking:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

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/

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",
      "storage_ptr": "string",
      "failure_reason": "string",
      "release": "string"
    }
  ]
}

Create error tracking symbol sets

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Response

Example request

Example response

Status 201

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",
  "storage_ptr": "string",
  "failure_reason": "string",
  "release": "string"
}

Retrieve error tracking symbol sets

Required API key scopes

error_tracking:read

Path parameters

id
string
project_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/

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",
  "storage_ptr": "string",
  "failure_reason": "string",
  "release": "string"
}

Update error tracking symbol sets

Path parameters

id
string
project_id
string

Response

Example request

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",
  "storage_ptr": "string",
  "failure_reason": "string",
  "release": "string"
}

Delete error tracking symbol sets

Required API key scopes

error_tracking:write

Path parameters

id
string
project_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/

Example response

Status 204 No response body

Create error tracking symbol sets bulk finish upload

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

ref
string
last_used
string
storage_ptr
string
failure_reason
string

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 ref="string"

Example response

Status 200 No response body

Create error tracking symbol sets bulk start upload

Required API key scopes

error_tracking:write

Path parameters

project_id
string

Request parameters

ref
string
last_used
string
storage_ptr
string
failure_reason
string

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 ref="string"

Example response

Status 200 No response body

Create error tracking symbol sets start upload

Required API key scopes

error_tracking:write

Path parameters

project_id
string