OCoctaneai
experiments

Read the complete experiment results

get/v1/experiments/{experiment_id}/results

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Path parameters

experiment_idstring required

Response

The complete results, including decision evidence, gates, periods and attention context.

as_ofstring date-time required

When these numbers were read, UTC ISO 8601; a read is served again for up to two hours

window_startstring date-time nullable required

The start of the visits counted, when the counting period began, UTC ISO 8601; null on a draft

window_endstring date-time nullable required

The end of the visits counted, as_of or when the test ended, UTC ISO 8601; null on a draft

frozenboolean required

True once the test has ended: the visits counted stop at its end while their orders keep arriving

admission_cutoffstring date-time nullable required

For a money decision metric on a live test, the decision counts only visits before this, UTC ISO 8601; null otherwise

admission_linestring nullable required
attribution_window_daysinteger required

The store's order-matching window in days: how long after a visit an order still counts

attribution_linestring required
cookieless_sharenumber nullable required

Share of visits without cookies, assigned a version per visit, 0 to 1; null without visits

cookieless_linestring nullable required
changed_sinceboolean required

Whether revenue arriving since the decision moved the lead past half the recorded range

changed_since_linestring nullable required
explainer_keysstring[] required

The camelCase names of the help topics that explain the numbers in this response

Example response

{
  "experiment": {
    "id": "expt_7c9e6679742540de944be07fc1f90ae7",
    "app_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
    "winner_arm_id": "arm_7c9e6679742540de944be07fc1f90ae7",
    "arms": [
      {
        "id": "arm_7c9e6679742540de944be07fc1f90ae7",
        "version_id": "ver_7c9e6679742540de944be07fc1f90ae7"
      }
    ]
  },
  "arms": [
    {
      "arm_id": "arm_7c9e6679742540de944be07fc1f90ae7",
      "version_id": "ver_7c9e6679742540de944be07fc1f90ae7"
    }
  ],
  "metrics": [
    {
      "control": {
        "arm_id": "arm_7c9e6679742540de944be07fc1f90ae7"
      },
      "variant": {
        "arm_id": "arm_7c9e6679742540de944be07fc1f90ae7"
      }
    }
  ],
  "events": [
    {
      "arm_id": "arm_7c9e6679742540de944be07fc1f90ae7"
    }
  ],
  "decision_trace": {
    "compared_version_ids": [
      "ver_7c9e6679742540de944be07fc1f90ae7"
    ]
  },
  "ai_decision_trace": {
    "compared_version_ids": [
      "ver_7c9e6679742540de944be07fc1f90ae7"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.