Get experiment

Read one experiment: what it tests (broadcast, or journey and split node), its arms, control, holdout and test shares, goal, minimum sample, status and, once promoted, the winner, who promoted it and whether significance was overridden (with the reason).

Outcome

Before you start

Verify identity and pin the intended organization and environment before discovering the action.
Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.experiments.get --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.experiments.list --detail --json

id: experiments record id in the selected workspace.

Request

GET /api/experiments/{id}

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Field	Required	Type	Constraints
`id`	Required	string	experiments record id in the selected workspace. {"minLength":1,"maxLength":64}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Reads one experiment without changing state.

Interpret the response

The returned identifier path is $.experiment.id for experiment. Empty lists do not discover a target.

Confirm $.experiment.id equals the requested id.

Exact success schema:

{
  "type": "object",
  "required": [
    "experiment"
  ],
  "properties": {
    "experiment": {
      "type": "object",
      "required": [
        "id",
        "kind",
        "status",
        "arms",
        "controlArm",
        "goal"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "kind": {
          "type": "string",
          "enum": [
            "broadcast",
            "journey"
          ]
        },
        "broadcastId": {
          "type": [
            "string",
            "null"
          ]
        },
        "journeyId": {
          "type": [
            "string",
            "null"
          ]
        },
        "nodeId": {
          "type": [
            "string",
            "null"
          ]
        },
        "arms": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "key",
              "weight"
            ],
            "properties": {
              "key": {
                "type": "string"
              },
              "label": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "weight": {
                "type": "integer"
              },
              "variant": {
                "type": "object"
              }
            }
          }
        },
        "controlArm": {
          "type": "string"
        },
        "holdoutPercent": {
          "type": "integer"
        },
        "testPercent": {
          "type": [
            "integer",
            "null"
          ]
        },
        "goal": {
          "type": "object",
          "required": [
            "kind",
            "windowHours"
          ],
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "event",
                "click"
              ]
            },
            "eventType": {
              "type": "string"
            },
            "urlPrefix": {
              "type": [
                "string",
                "null"
              ]
            },
            "windowHours": {
              "type": "integer"
            }
          }
        },
        "minSamplePerArm": {
          "type": "integer"
        },
        "confidenceLevel": {
          "type": "number"
        },
        "status": {
          "type": "string",
          "enum": [
            "active",
            "stopped",
            "promoted"
          ]
        },
        "winnerArm": {
          "type": [
            "string",
            "null"
          ]
        },
        "promotedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "promotedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "promotionOverride": {
          "type": "boolean"
        },
        "overrideReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "remainderRecipients": {
          "type": [
            "integer",
            "null"
          ]
        },
        "stoppedBy": {
          "type": [
            "string",
            "null"
          ]
        },
        "stoppedAt": {
          "type": [
            "string",
            "null"
          ]
        },
        "stopReason": {
          "type": [
            "string",
            "null"
          ]
        },
        "createdBy": {
          "type": "string"
        },
        "createdAt": {
          "type": "string"
        },
        "updatedAt": {
          "type": "string"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "exp_c4ad68c8d80e48aba9811cd4cd44e506"
}

CLI:

topolo actions validate app_topolo_nurture.experiments.get --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.experiments.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.experiments.get",
    "input": {
      "id": "exp_c4ad68c8d80e48aba9811cd4cd44e506"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "experiment": {
    "id": "exp_c4ad68c8d80e48aba9811cd4cd44e506",
    "name": "T",
    "kind": "broadcast",
    "broadcastId": "bc_eb04f6f7c31d482d9cad2a0c6d9a2a7a",
    "journeyId": null,
    "nodeId": null,
    "arms": [
      {
        "key": "a",
        "label": null,
        "weight": 50,
        "variant": {
          "subject": "S"
        }
      },
      {
        "key": "b",
        "label": null,
        "weight": 50,
        "variant": {
          "templateVersion": 1
        }
      }
    ],
    "controlArm": "b",
    "holdoutPercent": 0,
    "testPercent": null,
    "goal": {
      "kind": "event",
      "eventType": "purchase",
      "windowHours": 72
    },
    "minSamplePerArm": 100,
    "confidenceLevel": 0.95,
    "status": "active",
    "winnerArm": null,
    "promotedBy": null,
    "promotedAt": null,
    "promotionOverride": false,
    "overrideReason": null,
    "remainderRecipients": null,
    "stoppedBy": null,
    "stoppedAt": null,
    "stopReason": null,
    "createdBy": "u1",
    "createdAt": "2026-10-04T00:32:34.584Z",
    "updatedAt": "2026-10-04T00:32:34.584Z"
  }
}

HTTP 200. Confirm $.experiment.id equals the requested id.

Another supported request

Input · payload.json:

{
  "id": "exp_cea63c87835c4b7b8ced5026490e7938"
}

CLI:

topolo actions validate app_topolo_nurture.experiments.get --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.experiments.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.experiments.get",
    "input": {
      "id": "exp_cea63c87835c4b7b8ced5026490e7938"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "experiment": {
    "id": "exp_cea63c87835c4b7b8ced5026490e7938",
    "name": "Clicks",
    "kind": "broadcast",
    "broadcastId": "bc_ac93c2c4c38545d49c3096d45ee4a6ea",
    "journeyId": null,
    "nodeId": null,
    "arms": [
      {
        "key": "control",
        "label": null,
        "weight": 50,
        "variant": {}
      },
      {
        "key": "variant",
        "label": null,
        "weight": 50,
        "variant": {
          "subject": "Ready?"
        }
      }
    ],
    "controlArm": "control",
    "holdoutPercent": 0,
    "testPercent": null,
    "goal": {
      "kind": "event",
      "eventType": "purchase",
      "windowHours": 72
    },
    "minSamplePerArm": 100,
    "confidenceLevel": 0.95,
    "status": "active",
    "winnerArm": null,
    "promotedBy": null,
    "promotedAt": null,
    "promotionOverride": false,
    "overrideReason": null,
    "remainderRecipients": null,
    "stoppedBy": null,
    "stoppedAt": null,
    "stopReason": null,
    "createdBy": "u1",
    "createdAt": "2026-10-04T00:32:36.049Z",
    "updatedAt": "2026-10-04T00:32:36.049Z"
  }
}

HTTP 200. Confirm $.experiment.id equals the requested id.

Refused request · not_found

Input · payload.json:

{
  "id": "exp_missing"
}

CLI:

topolo actions validate app_topolo_nurture.experiments.get --data @payload.json --json
topolo actions plan app_topolo_nurture.experiments.get --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": {
    "code": "not_found",
    "message": "Experiment was not found in this workspace."
  }
}

HTTP 404. Preserve the refusal details and do not claim success.

Verify the result

Confirm $.experiment.id equals the requested id.

Errors and recovery

organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.
not_found (HTTP 404): List experiments to find a valid id in this workspace.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

This action does not change service state.

Get experiment results: Per arm: contacts assigned and exposed, conversions, conversion rate, uplift against the control (absolute and relative) and against the holdout, z and p-value. Statistics: a pooled two-proportion z-test of each variant against the control at a fixed 95% confidence level, alpha split across variants (Bonferroni); a comparison counts only when both arms reach minSamplePerArm exposures (default 100). decision is winner (recommendedWinner set), control_wins, insufficient_sample or no_significant_difference; a winner is never declared without significance. Conversion, within goal.windowHours after exposure (send, split or withheld holdout): goal.kind event (default) = the lifecycle eventType (e.g. purchase); click = a tracked-link click on the experiment's own sends, only URLs starting with urlPrefix if set.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.

Get experiment

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Refused request · not_found

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence