Retrieve an experiment

curl --request GET \
  --url https://api.mercemur.com/api/v1/experiments/{experimentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/experiments/{experimentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/experiments/{experimentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/experiments/{experimentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "audience_id": "<string>",
    "created_at": "<string>",
    "ended_at": null,
    "exclusion_group": "<string>",
    "hypothesis": "<string>",
    "id": "<string>",
    "mode": "<string>",
    "name": "<string>",
    "primary_metric": "<string>",
    "ramp_minutes": 123,
    "started_at": "<string>",
    "status": "<string>",
    "traffic_bps": 123,
    "type": "<string>",
    "updated_at": "<string>",
    "variants": [
      {
        "allocation_bps": 123,
        "config": {},
        "created_at": "<string>",
        "id": "<string>",
        "is_control": true,
        "key": "<string>",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

API Reference

Retrieve an experiment

One experiment with its arms, in the same shape the list serves, so a row read from a page can be re-read on its own rather than by walking the list again. An experiment belonging to another store is a 404 here exactly as it is invisible in the list. audience_id is a SOFT reference: deleting an audience never breaks a running test, because assignment treats a missing one as “all visitors”. Read a 404 from GET /api/v1/experiment-audiences/ as “untargeted”, not as a broken row.

GET

api

experiments

{experimentId}

Retrieve an experiment

curl --request GET \
  --url https://api.mercemur.com/api/v1/experiments/{experimentId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mercemur.com/api/v1/experiments/{experimentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/experiments/{experimentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/experiments/{experimentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "audience_id": "<string>",
    "created_at": "<string>",
    "ended_at": null,
    "exclusion_group": "<string>",
    "hypothesis": "<string>",
    "id": "<string>",
    "mode": "<string>",
    "name": "<string>",
    "primary_metric": "<string>",
    "ramp_minutes": 123,
    "started_at": "<string>",
    "status": "<string>",
    "traffic_bps": 123,
    "type": "<string>",
    "updated_at": "<string>",
    "variants": [
      {
        "allocation_bps": 123,
        "config": {},
        "created_at": "<string>",
        "id": "<string>",
        "is_control": true,
        "key": "<string>",
        "name": "<string>"
      }
    ]
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Path Parameters

experimentId

string

required

Response

Success

data

object

Show child attributes

Overview

Endpoints

Retrieve an experiment

Authorizations

Path Parameters

Response