Start Experiment.

POST /api/teams/{team}/experiments/{experiment}/start
Default

Path parameters

  • team integer Required

    The ID of the team that the experiment belongs to.

  • experiment string Required

    The experiment key to start.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • id string
      • type string
      • attributes object
        Hide attributes attributes Show attributes attributes object
        • id integer
        • team_id integer
        • key string
        • description string
        • status string
        • created object
          Hide created attributes Show created attributes object
          • human string
          • string string
        • updated object
          Hide updated attributes Show updated attributes object
          • human string
          • string string
        • started object
          Hide started attributes Show started attributes object
          • human string
          • string string
        • stopped object
          Hide stopped attributes Show stopped attributes object
          • human string
          • string string
      • links object
        Hide links attribute Show links attribute object
        • self object
          Hide self attribute Show self attribute object
          • href string
  • 403 application/json
    Hide response attribute Show response attribute object
    • message string
  • 404 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/teams/{team}/experiments/{experiment}/start 
curl \
 -X POST https://checkmango.com/api/teams/14/experiments/MY_NEW_EXPERIMENT/start \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "id": "VOLUPTATEM_EXPLICABO_AUT_MAIORES_UT",
    "type": "experiments",
    "attributes": {
      "id": 7,
      "team_id": 18,
      "key": "VOLUPTATEM_EXPLICABO_AUT_MAIORES_UT",
      "description": null,
      "status": "draft",
      "created": {
        "human": "1 second ago",
        "string": "2024-04-08 10:42:02"
      },
      "updated": {
        "human": "1 second ago",
        "string": "2024-04-08 10:42:02"
      },
      "started": {
        "human": null,
        "string": null
      },
      "stopped": {
        "human": null,
        "string": null
      }
    },
    "links": {
      "self": {
        "href": "http://checkmango.com/api/teams/18/experiments/VOLUPTATEM_EXPLICABO_AUT_MAIORES_UT"
      }
    }
  }
}
Response examples (403) 
{
  "message": "Unauthenticated."
}
Response examples (404) 
{
  "message": "Not Found"
}