Organizations
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
| GET | |
| POST | |
| GET | |
| PATCH | |
| DELETE | |
| POST | |
| GET | |
| POST | |
| GET | |
| PATCH | |
| DELETE | |
| POST | 
Retrieve
Required API key scopes
organization:readQuery parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Example request
GET Example response
Status 200
Retrieve
Required API key scopes
organization:readQuery parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Example request
GET Example response
Status 200
Create
Required API key scopes
organization:writeRequest parameters
- namestring
- logo_media_idstring
- is_member_join_email_enabledboolean
- enforce_2faboolean
- members_can_inviteboolean
- members_can_use_personal_api_keysboolean
- allow_publicly_shared_resourcesboolean
- is_ai_data_processing_approvedboolean
- default_experiment_stats_methodDefault statistical method for new experiments in this organization. - bayesian- Bayesian
- frequentist- Frequentist
 
- default_role_idstringID of the role to automatically assign to new members joining the organization 
Response
Example request
POST Example response
Status 201
Create
Required API key scopes
organization:writeRequest parameters
- namestring
- logo_media_idstring
- is_member_join_email_enabledboolean
- enforce_2faboolean
- members_can_inviteboolean
- members_can_use_personal_api_keysboolean
- allow_publicly_shared_resourcesboolean
- is_ai_data_processing_approvedboolean
- default_experiment_stats_methodDefault statistical method for new experiments in this organization. - bayesian- Bayesian
- frequentist- Frequentist
 
- default_role_idstringID of the role to automatically assign to new members joining the organization 
Response
Example request
POST Example response
Status 201
Retrieve
Required API key scopes
organization:readPath parameters
- idstringA UUID string identifying this organization. 
Response
Example request
GET Example response
Status 200
Retrieve
Required API key scopes
organization:readPath parameters
- idstringA UUID string identifying this organization. 
Response
Example request
GET Example response
Status 200
Update partial
Required API key scopes
organization:writePath parameters
- idstringA UUID string identifying this organization. 
Request parameters
- namestring
- logo_media_idstring
- is_member_join_email_enabledboolean
- enforce_2faboolean
- members_can_inviteboolean
- members_can_use_personal_api_keysboolean
- allow_publicly_shared_resourcesboolean
- is_ai_data_processing_approvedboolean
- default_experiment_stats_methodDefault statistical method for new experiments in this organization. - bayesian- Bayesian
- frequentist- Frequentist
 
- default_role_idstringID of the role to automatically assign to new members joining the organization 
Response
Example request
PATCH Example response
Status 200
Update partial
Required API key scopes
organization:writePath parameters
- idstringA UUID string identifying this organization. 
Request parameters
- namestring
- logo_media_idstring
- is_member_join_email_enabledboolean
- enforce_2faboolean
- members_can_inviteboolean
- members_can_use_personal_api_keysboolean
- allow_publicly_shared_resourcesboolean
- is_ai_data_processing_approvedboolean
- default_experiment_stats_methodDefault statistical method for new experiments in this organization. - bayesian- Bayesian
- frequentist- Frequentist
 
- default_role_idstringID of the role to automatically assign to new members joining the organization 
Response
Example request
PATCH Example response
Status 200
Delete
Required API key scopes
organization:writePath parameters
- idstringA UUID string identifying this organization. 
Example request
DELETE Example response
Status 204 No response body
Delete
Required API key scopes
organization:writePath parameters
- idstringA UUID string identifying this organization. 
Example request
DELETE Example response
Status 204 No response body
Create environments rollback
Trigger environments rollback migration for users previously on multi-environment projects. The request data should be a mapping of source environment IDs to target environment IDs. Example: { "2": 2, "116911": 2, "99346": 99346, "140256": 99346 }
Path parameters
- idstringA UUID string identifying this organization. 
Request parameters
- namestring
- logo_media_idstring
- is_member_join_email_enabledboolean
- enforce_2faboolean
- members_can_inviteboolean
- members_can_use_personal_api_keysboolean
- allow_publicly_shared_resourcesboolean
- is_ai_data_processing_approvedboolean
- default_experiment_stats_methodDefault statistical method for new experiments in this organization. - bayesian- Bayesian
- frequentist- Frequentist
 
- default_role_idstringID of the role to automatically assign to new members joining the organization 
Response
Example request
POST Example response
Status 200
List all batch exports
Required API key scopes
batch_export:readPath parameters
- organization_idstring
Query parameters
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
Response
Example request
GET Example response
Status 200
Create batch exports
Required API key scopes
batch_export:writePath parameters
- organization_idstring
Request parameters
- namestringA human-readable name for this BatchExport. 
- modelWhich model this BatchExport is exporting. - events- Events
- persons- Persons
- sessions- Sessions
 
- destination
- interval
- pausedbooleanWhether this BatchExport is paused or not. 
- last_paused_atstringThe timestamp at which this BatchExport was last paused. 
- start_atstringTime before which any Batch Export runs won't be triggered. 
- end_atstringTime after which any Batch Export runs won't be triggered. 
- hogql_querystring
- filters
Response
Example request
POST Example response
Status 201
Retrieve batch exports
Required API key scopes
batch_export:readPath parameters
- idstringA UUID string identifying this batch export. 
- organization_idstring
Response
Example request
GET Example response
Status 200
Update batch exports
Required API key scopes
batch_export:writePath parameters
- idstringA UUID string identifying this batch export. 
- organization_idstring
Request parameters
- namestringA human-readable name for this BatchExport. 
- modelWhich model this BatchExport is exporting. - events- Events
- persons- Persons
- sessions- Sessions
 
- destination
- interval
- pausedbooleanWhether this BatchExport is paused or not. 
- last_paused_atstringThe timestamp at which this BatchExport was last paused. 
- start_atstringTime before which any Batch Export runs won't be triggered. 
- end_atstringTime after which any Batch Export runs won't be triggered. 
- hogql_querystring
- filters
Response
Example request
PATCH Example response
Status 200
Delete batch exports
Required API key scopes
batch_export:writePath parameters
- idstringA UUID string identifying this batch export. 
- organization_idstring
Example request
DELETE Example response
Status 204 No response body
Create batch exports backfill
Trigger a backfill for a BatchExport.
Note: This endpoint is deprecated. Please use POST /batch_exports/<id>/backfills/ instead.
Required API key scopes
batch_export:writePath parameters
- idstringA UUID string identifying this batch export. 
- organization_idstring
Request parameters
- namestringA human-readable name for this BatchExport. 
- modelWhich model this BatchExport is exporting. - events- Events
- persons- Persons
- sessions- Sessions
 
- destination
- interval
- pausedbooleanWhether this BatchExport is paused or not. 
- last_paused_atstringThe timestamp at which this BatchExport was last paused. 
- start_atstringTime before which any Batch Export runs won't be triggered. 
- end_atstringTime after which any Batch Export runs won't be triggered. 
- hogql_querystring
- filters
Example request
POST