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
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET /api /organizationsExample response
Status 200
Retrieve
Required API key scopes
organization:readQuery parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET /api /organizationsExample 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_method
Default statistical method for new experiments in this organization.
bayesian- Bayesianfrequentist- Frequentist
- default_role_idstring
ID of the role to automatically assign to new members joining the organization
Response
Example request
POST /api /organizationsExample 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_method
Default statistical method for new experiments in this organization.
bayesian- Bayesianfrequentist- Frequentist
- default_role_idstring
ID of the role to automatically assign to new members joining the organization
Response
Example request
POST /api /organizationsExample response
Status 201
Retrieve
Required API key scopes
organization:readPath parameters
- idstring
A UUID string identifying this organization.
Response
Example request
GET /api /organizations /:idExample response
Status 200
Retrieve
Required API key scopes
organization:readPath parameters
- idstring
A UUID string identifying this organization.
Response
Example request
GET /api /organizations /:idExample response
Status 200
Update partial
Required API key scopes
organization:writePath parameters
- idstring
A 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_method
Default statistical method for new experiments in this organization.
bayesian- Bayesianfrequentist- Frequentist
- default_role_idstring
ID of the role to automatically assign to new members joining the organization
Response
Example request
PATCH /api /organizations /:idExample response
Status 200
Update partial
Required API key scopes
organization:writePath parameters
- idstring
A 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_method
Default statistical method for new experiments in this organization.
bayesian- Bayesianfrequentist- Frequentist
- default_role_idstring
ID of the role to automatically assign to new members joining the organization
Response
Example request
PATCH /api /organizations /:idExample response
Status 200
Delete
Required API key scopes
organization:writePath parameters
- idstring
A UUID string identifying this organization.
Example request
DELETE /api /organizations /:idExample response
Status 204 No response body
Delete
Required API key scopes
organization:writePath parameters
- idstring
A UUID string identifying this organization.
Example request
DELETE /api /organizations /:idExample 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
- idstring
A 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_method
Default statistical method for new experiments in this organization.
bayesian- Bayesianfrequentist- Frequentist
- default_role_idstring
ID of the role to automatically assign to new members joining the organization
Response
Example request
POST /api /organizations /:id /environments_rollbackExample response
Status 200
List all batch exports
Required API key scopes
batch_export:readPath parameters
- organization_idstring
Query parameters
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
Response
Example request
GET /api /organizations /:organization_id /batch_exportsExample response
Status 200
Create batch exports
Required API key scopes
batch_export:writePath parameters
- organization_idstring
Request parameters
- namestring
A human-readable name for this BatchExport.
- model
Which model this BatchExport is exporting.
events- Eventspersons- Personssessions- Sessions
- destination
- interval
- pausedboolean
Whether this BatchExport is paused or not.
- last_paused_atstring
The timestamp at which this BatchExport was last paused.
- start_atstring
Time before which any Batch Export runs won't be triggered.
- end_atstring
Time after which any Batch Export runs won't be triggered.
- hogql_querystring
- filters
Response
Example request
POST /api /organizations /:organization_id /batch_exportsExample response
Status 201
Retrieve batch exports
Required API key scopes
batch_export:readPath parameters
- idstring
A UUID string identifying this batch export.
- organization_idstring
Response
Example request
GET /api /organizations /:organization_id /batch_exports /:idExample response
Status 200
Update batch exports
Required API key scopes
batch_export:writePath parameters
- idstring
A UUID string identifying this batch export.
- organization_idstring
Request parameters
- namestring
A human-readable name for this BatchExport.
- model
Which model this BatchExport is exporting.
events- Eventspersons- Personssessions- Sessions
- destination
- interval
- pausedboolean
Whether this BatchExport is paused or not.
- last_paused_atstring
The timestamp at which this BatchExport was last paused.
- start_atstring
Time before which any Batch Export runs won't be triggered.
- end_atstring
Time after which any Batch Export runs won't be triggered.
- hogql_querystring
- filters
Response
Example request
PATCH /api /organizations /:organization_id /batch_exports /:idExample response
Status 200
Delete batch exports
Required API key scopes
batch_export:writePath parameters
- idstring
A UUID string identifying this batch export.
- organization_idstring
Example request
DELETE /api /organizations /:organization_id /batch_exports /:idExample 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
- idstring
A UUID string identifying this batch export.
- organization_idstring
Request parameters
- namestring
A human-readable name for this BatchExport.
- model
Which model this BatchExport is exporting.
events- Eventspersons- Personssessions- Sessions
- destination
- interval
- pausedboolean
Whether this BatchExport is paused or not.
- last_paused_atstring
The timestamp at which this BatchExport was last paused.
- start_atstring
Time before which any Batch Export runs won't be triggered.
- end_atstring
Time after which any Batch Export runs won't be triggered.
- hogql_querystring
- filters
Example request
POST /api /organizations /:organization_id /batch_exports /:id /backfill