Experiments
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all experiments
Path Parameters
- project_idstring
Query Parameters
- limitinteger
- offsetinteger
Response
Request
GET
/api /projects /:project_id /experiments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/
Response
RESPONSE
{"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,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}]}
Create experiments
Path Parameters
- project_idstring
Request Parameters
- namestring
- descriptionstring
- start_datestring
- end_datestring
- feature_flag_keystring
- parametersobject
- secondary_metricsobject
- filtersobject
- archivedboolean
Response
Request
POST
/api /projects /:project_id /experiments
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl-H 'Content-Type: application/json'\-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/\-d name="string",\-d feature_flag_key="string"
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Retrieve experiments
Path Parameters
- idinteger
- project_idstring
Response
Request
GET
/api /projects /:project_id /experiments /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/:id/
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Update experiments
Path Parameters
- idinteger
- project_idstring
Request Parameters
- namestring
- descriptionstring
- start_datestring
- end_datestring
- feature_flag_keystring
- parametersobject
- secondary_metricsobject
- filtersobject
- archivedboolean
Response
Request
PATCH
/api /projects /:project_id /experiments /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X PATCH \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/:id/\-d name="string"
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Delete experiments
Path Parameters
- idinteger
- project_idstring
Request
DELETE
/api /projects /:project_id /experiments /:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl -X DELETE \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/:id/
Response
No responseRetrieve experiments results
Path Parameters
- idinteger
- project_idstring
Response
Request
GET
/api /projects /:project_id /experiments /:id /results
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/:id/results/
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Retrieve experiments secondary results
Path Parameters
- idinteger
- project_idstring
Response
Request
GET
/api /projects /:project_id /experiments /:id /secondary_results
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/:id/secondary_results/
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}
Retrieve experiments requires flag implementation
Path Parameters
- project_idstring
Response
Request
GET
/api /projects /:project_id /experiments /requires_flag_implementation
export POSTHOG_PERSONAL_API_KEY=[your personal api key]curl \-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \https://app.posthog.com/api/projects/:project_id/experiments/requires_flag_implementation/
Response
RESPONSE
{"id": 0,"name": "string","description": "string","start_date": "2019-08-24T14:15:22Z","end_date": "2019-08-24T14:15:22Z","feature_flag_key": "string","feature_flag": 0,"parameters": {"property1": null,"property2": null},"secondary_metrics": {"property1": null,"property2": null},"filters": {"property1": null,"property2": null},"archived": true,"created_by": {"id": 0,"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f","distinct_id": "string","first_name": "string","email": "user@example.com","is_email_verified": true},"created_at": "2019-08-24T14:15:22Z","updated_at": "2019-08-24T14:15:22Z"}