Environments-10
For instructions on how to authenticate to use this endpoint, see API overview.
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.
Endpoints
Retrieve environments persons path
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 /persons /path
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/path/
Response
Status 200 No response body
Retrieve environments persons path
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 /persons /path
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/path/
Response
Status 200 No response body
Create environments persons path
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
- properties
Request
POST
/api /environments /:project_id /persons /path
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/path/\-d name="string"
Response
Status 200 No response body
Create environments persons path
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
- properties
Request
POST
/api /environments /:project_id /persons /path
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/path/\-d name="string"
Response
Status 200 No response body
Retrieve environments persons retention
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 /persons /retention
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/retention/
Response
Status 200 No response body
Retrieve environments persons retention
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 /persons /retention
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/retention/
Response
Status 200 No response body
Retrieve environments persons stickiness
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 /persons /stickiness
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/stickiness/
Response
Status 200 No response body
Retrieve environments persons stickiness
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 /persons /stickiness
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/stickiness/
Response
Status 200 No response body
Retrieve environments persons trends
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 /persons /trends
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/trends/
Response
Status 200 No response body
Retrieve environments persons trends
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 /persons /trends
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/trends/
Response
Status 200 No response body
Retrieve environments persons values
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /: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/environments/:project_id/persons/values/
Response
Status 200 No response body
Retrieve environments persons values
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
- formatstringOne of:
"csv"
"json"
Request
GET
/api /environments /: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/environments/:project_id/persons/values/
Response
Status 200 No response body
List all environments pipeline destination configs
Required API key scopes
plugin: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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /environments /:project_id /pipeline_destination_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/pipeline_destination_configs/
Response
Status 200
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}]}
List all environments pipeline destination configs
Required API key scopes
plugin: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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Request
GET
/api /environments /:project_id /pipeline_destination_configs
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \<ph_app_host>/api/environments/:project_id/pipeline_destination_configs/
Response
Status 200
{"count": 123,"next": "http://api.example.org/accounts/?offset=400&limit=100","previous": "http://api.example.org/accounts/?offset=200&limit=100","results": [{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}]}
Create environments pipeline destination configs
Required API key scopes
plugin:write
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/.
Request parameters
- plugininteger
- enabledboolean
- orderinteger
- namestring
- descriptionstring
- deletedboolean
Response
Request
POST
/api /environments /:project_id /pipeline_destination_configs
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/pipeline_destination_configs/\-d plugin="integer",\-d order="integer"
Response
Status 201
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}
Create environments pipeline destination configs
Required API key scopes
plugin:write
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/.
Request parameters
- plugininteger
- enabledboolean
- orderinteger
- namestring
- descriptionstring
- deletedboolean
Response
Request
POST
/api /environments /:project_id /pipeline_destination_configs
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/pipeline_destination_configs/\-d plugin="integer",\-d order="integer"
Response
Status 201
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}
Retrieve environments pipeline destination configs
Required API key scopes
plugin:read
Path parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Response
Request
GET
/api /environments /:project_id /pipeline_destination_configs /: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/pipeline_destination_configs/:id/
Response
Status 200
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}
Retrieve environments pipeline destination configs
Required API key scopes
plugin:read
Path parameters
- idinteger
A unique integer value identifying this plugin config.
- 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/.
Response
Request
GET
/api /environments /:project_id /pipeline_destination_configs /: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/pipeline_destination_configs/:id/
Response
Status 200
{"id": 0,"plugin": 0,"enabled": true,"order": -2147483648,"config": "string","error": "string","team_id": 0,"plugin_info": "string","delivery_rate_24h": "string","created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z","name": "string","description": "string","deleted": true}