---
title: "Read Experiments"
method: GET
path: "/admin/experiments/"
tags: ["admin", "experiments"]
---

# Read Experiments

`GET /admin/experiments/`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/admin/experiments/`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Query parameters

- `status` 'draft' | 'running' | 'paused' | 'ended'
- `limit` integer
- `offset` integer

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- ExperimentPagePublic
  - `items` ExperimentPublic[], required
    - `id` string, required
    - `organization_id` string, nullable, required
    - `name` string, required
    - `hypothesis` string, required
    - `scope` ExperimentTypedReference, required
      - `type` string, required
      - `id` string, required
    - `assignment_unit_type` string, required
    - `enrollment_percentage` string, required
    - `primary_metric_key` string, required
    - `guardrail_metric_keys` string[], required
    - `relative_mde` string, nullable, required
    - `status` 'draft' | 'running' | 'paused' | 'ended', required
    - `posthog_experiment_id` integer, nullable, required
    - `posthog_feature_flag_id` integer, nullable, required
    - `posthog_dashboard_id` integer, nullable, required
    - `posthog_feature_flag_key` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `arms` ExperimentArmPublic[], required
      - `id` string, required
      - `key` string, required
      - `name` string, required
      - `role` 'control' | 'candidate', required
      - `allocation_percentage` string, required
      - `target` ExperimentTypedReference
        - `type` string, required
        - `id` string, required
      - `change_spec` ExperimentChangeSpec: The delta a multi-participant candidate arm applies per participant — either an objective/hook link repoint to a global version, or a model override (the all-agents fleet scope). An arm carries link repoints or a model, never both.
        - `objective_links` ChangeSpecObjectiveLink[]
          - `group_id` string, required
          - `objective_id` string, required
        - `hook_links` ChangeSpecHookLink[]
          - `group_id` string, required
          - `hook_id` string, required
        - `model` string, nullable
        - `system_prompt_components` SystemPromptComponentReference[], nullable
          - `prompt_name` string, required
          - `prompt_version` string, required
          - `parameters` object
    - `participants` ExperimentParticipantPublic[]
      - `id` string, required
      - `organization_id` string, required
      - `agent_v2_id` string, required
    - `runs` ExperimentRunPublic[], required
      - `id` string, required
      - `run_number` integer, required
      - `status` 'pending' | 'running' | 'paused' | 'ended', required
      - `started_at` string, date-time, nullable, required
      - `ended_at` string, date-time, nullable, required
      - `config_hash` string, required
      - `arms` ExperimentRunArmPublic[], required
        - `id` string, required
        - `key` string, required
        - `name` string, required
        - `role` 'control' | 'candidate', required
        - `allocation_percentage` string, required
        - `target` ExperimentTypedReference
          - `type` string, required
          - `id` string, required
    - `progress` ExperimentProgress
      - `target_exposures` integer, nullable, required
      - `accrued_exposures` integer, required
      - `fraction` number, nullable, required
      - `per_variation` object, required
      - `observed_daily_rate` number, required
      - `estimated_days_remaining` integer, nullable, required
      - `target_reached` boolean, required
    - `results` ExperimentResults
      - `verdict` string, required
      - `primary` MetricVerdictPublic, required
        - `metric_key` string, required
        - `is_primary` boolean, required
        - `has_data` boolean, required
        - `is_significant` boolean, required
        - `higher_is_better` boolean, required
        - `baseline_variation` string, required
        - `baseline_rate` number, nullable, required
        - `candidate_variation` string, nullable, required
        - `candidate_rate` number, nullable, required
        - `effect_relative` number, nullable, required
        - `probability_best` number, nullable, required
        - `credible_interval` unknown[], nullable, required
          - unknown
        - `direction` string, required
        - `winning_variation` string, nullable, required
      - `guardrails` MetricVerdictPublic[], required
        - `metric_key` string, required
        - `is_primary` boolean, required
        - `has_data` boolean, required
        - `is_significant` boolean, required
        - `higher_is_better` boolean, required
        - `baseline_variation` string, required
        - `baseline_rate` number, nullable, required
        - `candidate_variation` string, nullable, required
        - `candidate_rate` number, nullable, required
        - `effect_relative` number, nullable, required
        - `probability_best` number, nullable, required
        - `credible_interval` unknown[], nullable, required
          - unknown
        - `direction` string, required
        - `winning_variation` string, nullable, required
      - `fetched_at` string, date-time, required
      - `stale` boolean, required
  - `total` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)