List Experiments

GET

https://restapi.ordergroove.com/experiments/list-experiments/

GET

/experiments/list-experiments/

curl -G https://restapi.ordergroove.com/experiments/list-experiments/ \
     -H "x-api-key: <apiKey>" \
     -d merchant_public_id=merchant_public_id

{
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
    {
      "public_id": "abc123def456ghi789jkl012mno345pqr678",
      "merchant": "merchant123def456ghi789jkl012mno345pqr678",
      "name": "Discount Strategy A/B Test Q4 2025",
      "description": "Testing different discount strategies to improve retention rates",
      "hypothesis": "20% discount every 5 orders will increase retention rate by 15%",
      "primary_metric": "recovery_rate",
      "guardrail_metric": "retry_efficiency",
      "experiment_type": "offer_incentives",
      "scheduled_finish_time": "2024-02-31T23:59:59Z",
      "status": "running",
      "started_at": "2024-01-15T10:30:00Z",
      "ended_at": "2024-02-15T10:30:00Z",
      "final_configuration": {
        "winning_variant": "variant_123",
        "confidence_level": 0.95,
        "winning_offer_profile": "offer_profile_public_id"
      },
      "created_at": "2024-01-01T10:00:00Z",
      "last_updated_at": "2024-01-15T10:30:00Z",
      "variants": [
        {
          "experiment": "ecb42bee71ff11efb72ef29e3ec3bb34",
          "public_id": "bf719da0720011ef819df29e3ec3bb34",
          "name": "Treatment variant",
          "weight": 50,
          "is_control": false,
          "created_at": "2024-09-13T13:48:20.928692",
          "last_updated_at": "2024-09-13T13:48:20.928723",
          "parameters": {
            "offer_profile_public_id": "43ad71484b7c11eb9afe36931c4b8b28"
          }
        },
        {
          "experiment": "ecb42bee71ff11efb72ef29e3ec3bb34",
          "public_id": "abc5d834720011ef9ac8e2793bd7407d",
          "name": "Control variant",
          "weight": 50,
          "is_control": true,
          "created_at": "2024-09-13T13:47:47.927550",
          "last_updated_at": "2024-09-13T13:47:47.927583",
          "parameters": {
            "offer_profile_public_id": "43ad71484b7c11eb9afe36931c4b8b28"
          }
        }
      ]
    }
  ]
}

Authentication

x-api-keystring

API Key authentication via header

Query parameters

merchant_public_idstringRequired

Merchant Public ID

experiment_typeenumOptional

Filters by experiment type

Allowed values:

statusenumOptional

Filters by status of experiment

Allowed values:

Response

200

countintegerOptionalDefaults to 0

nextstringOptional

previousstringOptional

resultslist of objectsOptional

Errors

400

Bad Request Error