Persons-4 API Reference

Persons-4

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

Endpoints

`GET`
`GET`

Retrieve persons trends

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve persons values

Required API key scopes

person:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Example response

Status 200 No response body

Retrieve persons values

Required API key scopes

person:read

Path parameters

project_id
string

Query parameters

format
string
One of: "csv""json"

Example request

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

Persons-4

Endpoints

Retrieve persons trends

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Retrieve persons values

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Retrieve persons values

Required API key scopes

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

Community questions