Environments-8
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
Create environments insights timing
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- namestring
- derived_namestring
- filters
- query
Query node JSON string
- orderinteger
- deletedboolean
- dashboardsarray
DEPRECATED. Will be removed in a future release. Use dashboard_tiles instead. A dashboard ID for each of the dashboards that this insight is displayed on.
- descriptionstring
- tagsarray
- favoritedboolean
- savedboolean
Request
POST
/api /environments /:project_id /insights /timing
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/insights/timing/\-d name="string"
Response
Status 200 No response body
Retrieve environments insights trend
Required API key scopes
insight:read
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /insights /trend
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/insights/trend/
Response
Status 200 No response body
Retrieve environments insights trend
Required API key scopes
insight:read
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /insights /trend
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/insights/trend/
Response
Status 200 No response body
Create
Required API key scopes
insight:read
Path parameters
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- eventsarray
Events to filter on. One of
events
oractions
is required. - actionsarray
Actions to filter on. One of
events
oractions
is required. - properties
Filter events by event property, person property, cohort, groups and more.
- filter_test_accountsboolean
Whether to filter out internal and test accounts. See "project settings" in your PostHog account for the filters.
- date_fromstringDefault:
-7d
What date to filter the results from. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - date_tostringDefault:
-7d
What date to filter the results to. Can either be a date
2021-01-01
, or a relative date, like-7d
for last seven days,-1m
for last month,mStart
for start of the month oryStart
for the start of the year. - breakdownstring
A property or cohort to break down on. You can select the type of the property with breakdown_type.
event
(default): a property keyperson
: a person property keycohort
: an array of cohort IDs (ie[9581,5812]
)
- breakdown_typeDefault:
event
Type of property to break down on.
event
- eventperson
- personcohort
- cohortgroup
- groupsession
- sessionhogql
- hogql
- compareboolean
To compare or not
- compare_tostring
What to compare to
- displayDefault:
ActionsLineGraph
How to display the data. Will change how the data is returned.
ActionsLineGraph
- ActionsLineGraphActionsLineGraphCumulative
- ActionsLineGraphCumulativeActionsTable
- ActionsTableActionsPie
- ActionsPieActionsBar
- ActionsBarActionsBarValue
- ActionsBarValueWorldMap
- WorldMapBoldNumber
- BoldNumber
- formulastring
Combine the result of events or actions into a single number. For example
A + B
or(A-B)/B
. The letters correspond to the order of theevents
oractions
lists.
Response
Request
POST
/api /environments /:project_id /insights /trend
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/insights/trend/\-d events=[{"id":"$pageview"}]
Response
Status 200
{"is_cached": true,"last_refresh": "2019-08-24T14:15:22Z","timezone": "UTC","result": [{"data": [0],"days": ["2019-08-24"],"labels": ["string"],"filter": {"events": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"actions": [{"id": "string","properties": [{"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]}],"math": "total"}],"properties": {"type": "AND","values": [{"key": "string","value": "string","operator": "exact","type": "event"}]},"filter_test_accounts": false,"date_from": "-7d","date_to": "-7d"},"label": "string"}]}
List all environments persons
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_idstring
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
- distinct_idstring
Filter list by distinct id.
- emailstring
Filter persons by email (exact match)
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- propertiesarray
Filter Persons by person properties.
- searchstring
Search persons, either by email (full text search) or distinct_id (exact match).
Response
Request
GET
/api /environments /:project_id /persons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/
Response
Status 200
{"next": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","previous": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","count": 400,"results": [{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}]}
List all environments persons
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_idstring
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
- distinct_idstring
Filter list by distinct id.
- emailstring
Filter persons by email (exact match)
- formatstringOne of:
"csv"
"json"
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- propertiesarray
Filter Persons by person properties.
- searchstring
Search persons, either by email (full text search) or distinct_id (exact match).
Response
Request
GET
/api /environments /:project_id /persons
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/
Response
Status 200
{"next": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","previous": "https://app.posthog.com/api/projects/{project_id}/accounts/?offset=400&limit=100","count": 400,"results": [{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}]}
Retrieve environments persons
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
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /persons /: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/persons/:id/
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Retrieve environments persons
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
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Response
Request
GET
/api /environments /:project_id /persons /: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/persons/:id/
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Update environments persons
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:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Response
Request
PATCH
/api /environments /:project_id /persons /: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/persons/:id/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Update environments persons
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:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Response
Request
PATCH
/api /environments /:project_id /persons /: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/persons/:id/\-d name="string"
Response
Status 200
{"id": 0,"name": "string","distinct_ids": ["string"],"properties": null,"created_at": "2019-08-24T14:15:22Z","uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"}
Delete environments persons
Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- delete_eventsboolean
If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
- formatstringOne of:
"csv"
"json"
Request
DELETE
/api /environments /:project_id /persons /: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/persons/:id/
Response
Status 204 No response body
Delete environments persons
Use this endpoint to delete individual persons. For bulk deletion, use the bulk_delete endpoint instead.
Required API key scopes
person:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- delete_eventsboolean
If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday
- formatstringOne of:
"csv"
"json"
Request
DELETE
/api /environments /:project_id /persons /: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/persons/:id/
Response
Status 204 No response body
Retrieve environments persons activity retrieve
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
activity_log:read
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /persons /:id /activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/activity/
Response
Status 200 No response body
Retrieve environments persons activity retrieve
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
activity_log:read
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /persons /:id /activity
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/activity/
Response
Status 200 No response body
Create environments persons delete property
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:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- $unsetstring
Specify the property key to delete
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Request
POST
/api /environments /:project_id /persons /:id /delete_property
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/persons/:id/delete_property/\-d name="string"
Response
Status 200 No response body
Create environments persons delete property
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:write
Path parameters
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- $unsetstring
Specify the property key to delete
- formatstringOne of:
"csv"
"json"
Request parameters
- properties
Request
POST
/api /environments /:project_id /persons /:id /delete_property
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/persons/:id/delete_property/\-d name="string"
Response
Status 200 No response body
Retrieve environments persons properties timeline
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
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /persons /:id /properties_timeline
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/properties_timeline/
Response
Status 200 No response body
Retrieve environments persons properties timeline
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
- idinteger
A unique integer value identifying this person.
- project_idstring
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /:project_id /persons /:id /properties_timeline
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/persons/:id/properties_timeline/