curl --request GET \
--url https://api.embeddables.com/projects/{projectId}/experiments/{experimentId}
{
"id": "exp_abc123",
"experimentId": "exp_abc123",
"flowId": "flow_123",
"name": "Button Color A/B Test",
"hypothesis": "Changing button color will improve conversion rates",
"impact_metrics": [
"conversion_rate",
"click_through_rate"
],
"no_impact_metrics": [
"bounce_rate"
],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"observations": "Users seem to prefer blue buttons",
"outcome": "Blue variant shows 15% higher conversion",
"attachments": "[{\"url\":\"/project/pr_rIu92Y0RXzLYemTB/library/?libraryItemId=recmqyMdB2FHK0WOC\",\"name\":\"HIMS - Weight Loss Plans\"}]",
"variants": "{\"control\": {\"name\": \"Control (Red)\", \"color\": \"#ff0000\"}, \"variant_a\": {\"name\": \"Blue Button\", \"color\": \"#0000ff\"}}",
"flow_ids": [
"flow_123",
"flow_456"
],
"paused_showing_variant": null,
"winner_variant": "variant_a",
"status": "running"
}
Retrieve an experiment from the database based on the experiment ID
curl --request GET \
--url https://api.embeddables.com/projects/{projectId}/experiments/{experimentId}
{
"id": "exp_abc123",
"experimentId": "exp_abc123",
"flowId": "flow_123",
"name": "Button Color A/B Test",
"hypothesis": "Changing button color will improve conversion rates",
"impact_metrics": [
"conversion_rate",
"click_through_rate"
],
"no_impact_metrics": [
"bounce_rate"
],
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"observations": "Users seem to prefer blue buttons",
"outcome": "Blue variant shows 15% higher conversion",
"attachments": "[{\"url\":\"/project/pr_rIu92Y0RXzLYemTB/library/?libraryItemId=recmqyMdB2FHK0WOC\",\"name\":\"HIMS - Weight Loss Plans\"}]",
"variants": "{\"control\": {\"name\": \"Control (Red)\", \"color\": \"#ff0000\"}, \"variant_a\": {\"name\": \"Blue Button\", \"color\": \"#0000ff\"}}",
"flow_ids": [
"flow_123",
"flow_456"
],
"paused_showing_variant": null,
"winner_variant": "variant_a",
"status": "running"
}
The unique identifier for a Project in the database
The unique identifier for an experiment
The response is of type object
.
Was this page helpful?