Persons-2 API Reference

Persons-2

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

Reset a distinct_id for a deleted person. This allows the distinct_id to be used again.

Endpoints

`POST`
`GET`
`GET`
`GET`

Create persons reset person distinct id

Required API key scopes

person:write

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "csv""json"

Request parameters

properties

Example request

POST /api/projects/:project_id/persons/reset_person_distinct_id

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/persons/reset_person_distinct_id/\
	-d name="string"

Example response

Status 200 No response body

Retrieve persons stickiness

This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set and $unset properties, or one of our SDKs.

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

format
string
One of: "csv""json"

Example request

GET /api/projects/:project_id/persons/stickiness

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

Example response

Status 200 No response body

Retrieve persons trends

This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set and $unset properties, or one of our SDKs.

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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/

Example response

Status 200 No response body

Retrieve persons values

This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the capture API, the $set and $unset properties, or one of our SDKs.

Required API key scopes

person:read

Path parameters

project_id
string
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

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/

Persons-2

Endpoints

Create persons reset person distinct id

Required API key scopes

Path parameters

Query parameters

Request parameters

Example request

Example response

Status 200 No response body

Retrieve persons stickiness

Path parameters

Query parameters

Example request

Example response

Status 200 No response body

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

Community questions