App API Reference

App

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

Endpoints

`GET`
`GET`
`GET`
`GET`
`GET`
`GET`
`GET`
`GET`

Retrieve environments app metrics

Required API key scopes

plugin:read

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/app_metrics/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/app_metrics/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/app_metrics/{app_metric_id}/".format(
        project_id=project_id,
		app_metric_id="<the app metric id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments app metrics error details

Path parameters

environment_id
string
id
integer

Example request

GET /api/environments/:environment_id/app_metrics/:id/error_details
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/app_metrics/:id/error_details/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/app_metrics/{app_metric_id}/error_details/".format(
        project_id=project_id,
		app_metric_id="<the app metric id>",
		environment_id="<the environment id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments app metrics historical exports

Required API key scopes

plugin:read

Path parameters

environment_id
string
plugin_config_id
string

Example request

GET /api/environments/:environment_id/app_metrics/:plugin_config_id/historical_exports
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/app_metrics/:plugin_config_id/historical_exports/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/app_metrics/{plugin_config_id}/historical_exports/".format(
        project_id=project_id,
		environment_id="<the environment id>",,
		plugin_config_id="<the plugin config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve environments app metrics historical exports retrieve

Required API key scopes

plugin:read

Path parameters

environment_id
string
id
string
plugin_config_id
string

Example request

GET /api/environments/:environment_id/app_metrics/:plugin_config_id/historical_exports/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/environments/:environment_id/app_metrics/:plugin_config_id/historical_exports/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/environments/{environment_id}/app_metrics/{plugin_config_id}/historical_exports/{app_metric_id}/".format(
        project_id=project_id,
		app_metric_id="<the app metric id>",
		environment_id="<the environment id>",,
		plugin_config_id="<the plugin config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve app metrics

Required API key scopes

plugin:read

Path parameters

id
integer
project_id
string

Example request

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

Example response

Status 200 No response body

Retrieve app metrics error details

Path parameters

id
integer
project_id
string

Example request

GET /api/projects/:project_id/app_metrics/:id/error_details
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/app_metrics/:id/error_details/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/app_metrics/{app_metric_id}/error_details/".format(
        project_id=project_id,
		app_metric_id="<the app metric id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve app metrics historical exports

Required API key scopes

plugin:read

Path parameters

plugin_config_id
string
project_id
string

Example request

GET /api/projects/:project_id/app_metrics/:plugin_config_id/historical_exports
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/app_metrics/:plugin_config_id/historical_exports/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/".format(
        project_id=project_id,
		plugin_config_id="<the plugin config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200 No response body

Retrieve app metrics historical exports retrieve

Required API key scopes

plugin:read

Path parameters

id
string
plugin_config_id
string
project_id
string

Example request

GET /api/projects/:project_id/app_metrics/:plugin_config_id/historical_exports/: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/app_metrics/:plugin_config_id/historical_exports/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/app_metrics/{plugin_config_id}/historical_exports/{app_metric_id}/".format(
        project_id=project_id,
		app_metric_id="<the app metric id>",
		plugin_config_id="<the plugin config id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

App

Endpoints

Retrieve environments app metrics

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments app metrics error details

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments app metrics historical exports

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve environments app metrics historical exports retrieve

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve app metrics

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve app metrics error details

Path parameters

Example request

Example response

Status 200 No response body

Retrieve app metrics historical exports

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Retrieve app metrics historical exports retrieve

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Community questions