> ## Documentation Index
> Fetch the complete documentation index at: https://docs.growthbook.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Archive an experiment

> An archived experiment leaves the SDK payload. Refused while a running experiment or a temporary rollout still serves through linked changes unless `linkedChanges` says what happens to them.



## OpenAPI

````yaml openapi.yaml POST /v1/experiments/{id}/archive
openapi: 3.1.0
info:
  version: 5.2.0
  title: GrowthBook REST API
  description: >
    GrowthBook offers a full REST API for interacting with the application.


    Request data can use either JSON or Form data encoding (with proper
    `Content-Type` headers). All response bodies are JSON-encoded.


    The API base URL for GrowthBook Cloud is `https://api.growthbook.io/api`.
    For self-hosted deployments, it is the same as your API_HOST environment
    variable (defaults to `http://localhost:3100/api`). The rest of these docs
    will assume you are using GrowthBook Cloud.


    ## Versioning


    Endpoints are versioned by path prefix:


    - `/v1/...` — stable, widely-supported endpoints

    - `/v2/...` — updated endpoints with improved shapes (e.g. unified per-rule
    environment scope for feature flags)


    New integrations should prefer v2 where available. Feature-flag and metric
    v1 routes are deprecated: they are tagged **LEGACY** in the sidebar and
    collapsed by default. Use the matching v2 group when both exist.


    ## Authentication


    We support both the HTTP Basic and Bearer authentication schemes for
    convenience.


    You first need to generate a new API Key in GrowthBook. Different keys have
    different permissions:


    - **Personal Access Tokens**: These are sensitive and provide the same level
    of access as the user has to an organization, or less if the token's
    permissions are limited. These can be created by going to `Personal Access
    Tokens` under your user menu. Members with the API Keys **Manage members'
    tokens** permission can disable a member's token under `Settings -> Manage
    PATs`, and admins can require new tokens to expire within a maximum
    lifetime.

    - **Secret Keys**: These are sensitive and provide the level of access of
    the role they are given, which can be any built-in or custom role, with
    optional per-project role overrides and environment limits. Managing Secret
    Keys on behalf of an organization takes the [API Keys
    permissions](/account/user-permissions). These can be created by going to
    `Settings -> API Keys`, where Admins can also require new Secret Keys to
    expire within a maximum lifetime.


    If using HTTP Basic auth, pass the Secret Key as the username and leave the
    password blank (when using curl, add `:` at the end of the secret to
    indicate an empty password)


    ```bash

    curl https://api.growthbook.io/api/v1/features \
      -u secret_abc123DEF456:
    ```


    If using Bearer auth, pass the Secret Key as the token:


    ```bash

    curl https://api.growthbook.io/api/v1/features \

    -H "Authorization: Bearer secret_abc123DEF456"

    ```


    If a key has an expiration date, every response includes it in the
    `X-GrowthBook-Key-Expires-At` header (ISO 8601), so scripts can warn before
    the key stops working. Requests made with an expired key fail with a `401`
    that says where to create a replacement. See
    [Expiration](/integrations/ai-agents/api-keys#expiration) for choosing a
    key's expiration, the warnings before it lapses, and the organization
    policies.


    ## Naming who asked


    Requests made with a Secret Key may add an `X-GrowthBook-Requested-By`
    header naming the organization member who asked for the change, as a user id
    or an email address. History, revision logs and webhooks show that member
    next to the key.


    Each key acts as **System** (the default) or **User**, set under `Settings
    -> API Keys`:


    - **System**: the header is optional. The key acts as itself, with its own
    permissions, and the named member is only recorded in history.

    - **User**: a request without the header is rejected with a 400. The request
    acts as the named member, with only what both the key and the member can do,
    so the header can narrow a key but never widen it. Drafts, owners, `mine`
    filters and reviews are the member's. The member's rights over their own
    drafts, comments and verdicts apply only where the key's own role allows the
    same action.


    A System key, or any key that names no one, acts as itself: it can draft and
    review with its own permissions, and its verdicts are judged on its role. A
    key belongs to no team, so its approval never satisfies a rule that requires
    approval from a team. No one can rule on a draft they created, and a key
    acting as itself can't rule on a draft it created or edited. An approval a
    User key gives counts only where both the key and the member could approve,
    and stops counting if the key is disabled, expires or is deleted. Because
    the header isn't verified, whoever holds the key can act as any member. A
    value that does not match a member of the organization is rejected with a
    400. A create request that omits `owner` defaults it to the member a User
    key names. Scheduled and auto-publishes run later with the permissions of
    the request that armed them, and don't run if that member has left the
    organization, the key has expired, or the key no longer acts as User.
    Personal Access Tokens and OAuth tokens already act as their user and reject
    the header.


    ```bash

    curl https://api.growthbook.io/api/v1/features \

    -H "Authorization: Bearer secret_abc123DEF456" \

    -H "X-GrowthBook-Requested-By: alice@example.com"

    ```


    ## Naming and human review


    People review what the API creates in the GrowthBook UI.


    - Keep keys and names short (2-5 words). Follow your organization's Feature
    Flag key format (`featureRegexValidator` and `featureKeyExample` in `GET
    /v1/settings`), or use kebab-case if it has none. Feature Flag keys can't be
    changed after creation, and an experiment's tracking key shouldn't change
    after launch.

    - Put context (why, plan, tickets, links) in `description`, not in names or
    keys.

    - Group with `tags`, not name prefixes. Projects (`project` or `projects`)
    control access and where a resource can be used, so set them deliberately
    instead of using them as labels.

    - To create a Feature Flag disabled with `POST /v2/features`, list every
    environment in `environments` with `enabled: false` (on `POST /v1/features`,
    each entry also needs `rules: []`). An environment you leave out uses its
    default state, which may be enabled.

    - Leave publishing and production changes to a person unless asked.

    - If a request is blocked (an approval requirement, a warning, a Custom
    Hook, schema validation or a permission error), stop and ask a person. Don't
    retry with an override field, a different key or another workaround unless a
    person asked you to. If a write answers `202` with a `confirmation`, give a
    person its `url` and wait (see [Waiting for
    confirmation](#waiting-for-confirmation)).


    ## Waiting for confirmation


    A key can require a person to confirm some writes before they run (see [API
    Keys for Agents](/integrations/ai-agents/api-keys#require-confirmation)). A
    held write doesn't run. It answers `202 Accepted` with the confirmation, a
    `Location` header to poll, and a `Retry-After` header with the seconds to
    wait between polls:


    ```json

    {
      "confirmation": {
        "id": "cnf_abc123",
        "status": "pending",
        "actions": [
          { "action": "feature.publish", "environments": ["production"] }
        ],
        "summary": "Publish revision 3 of checkout-redesign",
        "url": "https://app.growthbook.io/confirmations/cnf_abc123",
        "expiresAt": "2026-10-15T18:00:00.000Z",
        "response": null,
        "note": null
      },
      "message": "A person must confirm this in GrowthBook. Give them the url, then poll the Location."
    }

    ```


    Give the person the `url`, then poll [`GET
    /v1/confirmations/{id}`](/api/meta/operation/getConfirmation). Pass `wait`
    (in seconds, up to 30) to hold the poll open until the status changes:


    ```bash

    curl "https://api.growthbook.io/api/v1/confirmations/cnf_abc123?wait=30" \

    -H "Authorization: Bearer secret_abc123DEF456"

    ```


    | `status`    |
    Meaning                                                                                                              
    |

    | ----------- |
    ---------------------------------------------------------------------------------------------------------------------
    |

    | `pending`   | Waiting for a person, until `expiresAt` (an hour after the
    request)                                                   |

    | `running`   | Confirmed, and running
    now                                                                                           
    |

    | `completed` | It ran. `response` holds the status and body the request
    returned, which may be an error                              |

    | `rejected`  | A person declined it, and nothing
    ran                                                                                
    |

    | `expired`   | Nobody decided in time, or it acts on something that changed
    after it was held (with a `400` `response`). Nothing ran |


    `note` carries anything the person left for the agent when they decided.
    `actions` lists what the request was held for, each with the environments it
    touches.


    - Only the key that made the request, or another token of the same person,
    can read the confirmation.

    - Sending the same request again while it's pending returns the same
    confirmation.

    - A request that publishes, reverts or archives, or that changes a Feature
    Flag or an Experiment's status, schedule, targeting or traffic, isn't run if
    what it acts on changed after it was held. Other writes, such as editing
    settings or a draft, run as sent, so they can overwrite changes made while
    they waited.

    - A confirmed request runs once, with the key's permissions (or the member's
    role it assumes), not the confirmer's. Send it again to retry, which asks
    for a new confirmation.

    - Confirming isn't a review approval.


    ## Errors


    The API may return the following error status codes:


    - **400** - Bad Request - Often due to a missing required parameter

    - **401** - Unauthorized - No valid API key provided

    - **402** - Request Failed - The parameters are valid, but the request
    failed

    - **403** - Forbidden - Provided API key does not have the required access

    - **404** - Not Found - Unknown API route or requested resource

    - **409** - Conflict - The resource changed since it was read, or its state
    blocks the request, such as an experiment start's checklist. `code` names
    which.

    - **422** - Unprocessable Entity - The request is valid, but a warning,
    validation rule, approval requirement, or another publishing gate blocked
    it. Do not assume that `ignoreWarnings` clears every 422 response.

    - **429** - Too Many Requests - You exceeded the rate limit of 60 requests
    per minute, or the limit your self-hosted server sets. Try again later.

    - **5XX** - Server Error - Something went wrong on GrowthBook's end (these
    are rare)


    The response body will be a JSON object with the following properties:


    - **message** - Information about the error


    ### Publishing gates


    Automated callers, including AI agents, should report a blocked response to
    a person instead of retrying with an override. Use an override only when a
    person has explicitly asked for it.


    Publish and experiment start responses include a `gates` array that explains
    every blocker:


    - `type`, `severity`, and `messages` identify the problem.

    - `override` names the request-body field that can bypass it. This is
    `ignoreWarnings` for warnings, `skipSchemaValidation` for schema and
    invariant failures, `skipHooks` for Custom Hook rejections, or
    `skipChecklist` for an experiment start's launch checklist items. A value of
    `null` means there is no request-body override.

    - `requiresPermission` identifies any additional permission needed to use
    the override.

    - `resolution` provides an API action, method, and path when the blocker
    must be resolved another way.


    For example, an approval gate is cleared by approving the revision or by
    using a caller with **Bypass draft approvals** access. A Config lock is
    cleared through the unlock route in `resolution`.


    When a successful publish bypasses a gate, the response includes
    `bypassedGates`. Each entry reports the gate `type` and how it was bypassed
    in `via`, which is one of `ignoreWarnings`, `skipSchemaValidation`,
    `skipHooks`, `skipChecklist`, `bypassApprovalPermission`,
    `restApiBypassesReviews`, or `revertsBypassApproval` (reverts only). This
    field is omitted when no gates were bypassed.


    ### Request flags


    Every refusal a request can get past with a flag:


    | Flag                      | Where        | Gets
    past                                                                                                                  
    |

    | ------------------------- | ------------ |
    ---------------------------------------------------------------------------------------------------------------------------
    |

    | `ignoreWarnings`          | Body         | Warnings
    (`422`)                                                                                                           
    |

    | `skipSchemaValidation`    | Body         | Schema and invariant failures,
    with **Bypass draft approvals**
    access                                                       |

    | `skipHooks`               | Body         | Custom Hook
    rejections                                                                                                     
    |

    | `skipChecklist`           | Body         | An experiment start's
    incomplete launch checklist items (`409` `checklist_incomplete`), but not
    its blockers                |

    | `allowUnscopedRules`      | Body         | A rule for All Environments and
    All Projects where the organization requires a scope (`422`
    `unscoped_rule`)                |

    | `overrideDraftLimit=true` | Query string | Creating a draft past the draft
    limit                                                                                      
    |

    | `bypassApproval`          | Body         | A direct write to a resource
    that requires approval, with **Bypass draft approvals** access or the REST
    API approval bypass |
servers:
  - url: https://api.growthbook.io/api
    description: GrowthBook Cloud
  - url: https://{domain}/api
    description: Self-hosted GrowthBook
    variables:
      domain:
        default: localhost:3100
        description: Your self-hosted GrowthBook host (and port)
security:
  - bearerAuth: []
  - basicAuth: []
tags:
  - name: projects
    x-displayName: Projects
    description: Projects are used to organize your feature flags and experiments
  - name: environments
    x-displayName: Environments
    description: >-
      GrowthBook comes with one environment by default (production), but you can
      add as many as you need. When used with feature flags, you can
      enable/disable feature flags on a per-environment basis.
  - name: features-v2
    x-displayName: Feature Flags
    description: >-
      Control your feature flags programmatically.


      Rules are returned as a unified top-level array; each rule carries
      `allEnvironments` / `environments` scope fields instead of being bucketed
      by environment.
  - name: feature-revisions-v2
    x-displayName: Feature Revisions
    description: >-
      Draft revisions for feature flags, including rules, scheduling, and
      approval workflows.


      Revision `rules` is a flat array with per-rule scope fields.
  - name: features
    x-displayName: Feature Flags (legacy)
    description: >-
      Control your feature flags programmatically.


      **These are v1 endpoints.** New integrations should use the v2 Feature
      Flags endpoints, which expose a unified per-rule environment scope instead
      of per-environment rule arrays.
  - name: feature-revisions
    x-displayName: Feature Revisions (legacy)
    description: >-
      Draft revisions for feature flags, including rules, scheduling, and
      approval workflows.


      **These are v1 endpoints.** New integrations should use the v2 Feature
      Revisions endpoints.
  - name: ramp-schedules
    x-displayName: Ramp Schedules
    description: >-
      Multi-step rollout schedules that gradually increase feature rule traffic
      over time, with optional real-time monitoring. Each step supports interval
      timers, approval gates, and hold conditions. Monitored steps are backed by
      a live analysis experiment that can automatically hold, roll back, or
      advance the ramp based on guardrail and signal metric health.
  - name: data-sources
    x-displayName: Data Sources
    description: >-
      How GrowthBook connects and queries your data, including cached database
      schema metadata (information schemas) for tables and columns.
  - name: fact-tables
    x-displayName: Fact Tables
    description: Fact Tables describe the shape of your data warehouse tables
  - name: fact-metrics
    x-displayName: Fact Metrics
    description: Fact Metrics are metrics built on top of Fact Table definitions
  - name: metrics
    x-displayName: Metrics (legacy)
    description: Metrics used as goals and guardrails for experiments
  - name: experiments
    x-displayName: Experiments
    description: Experiments (A/B Tests)
  - name: namespaces
    x-displayName: Namespaces
    description: >-
      Namespaces partition your user population into buckets so that experiments
      using the same hash attribute do not overlap unintentionally. Each
      namespace defines a 0–1 range and individual experiments claim sub-ranges
      within it.
  - name: snapshots
    x-displayName: Experiment Snapshots
    description: Experiment Snapshots (the individual updates of an experiment)
  - name: dimensions
    x-displayName: Dimensions
    description: Dimensions used during experiment analysis
  - name: segments
    x-displayName: Segments
    description: Segments used during experiment analysis
  - name: reports
    x-displayName: Experiment Reports
    description: >-
      Custom analysis reports built on top of experiment snapshots. Reports let
      you re-run analysis with different metrics, date ranges, stats engines,
      and other settings without modifying the underlying experiment.
  - name: sdk-connections
    x-displayName: SDK Connections
    description: Client keys and settings for connecting SDKs to a GrowthBook instance
  - name: sdk-connection-revisions
    x-displayName: SDK Connection Revisions
    description: >-
      Draft revisions for SDK Connections: staged changes to a connection's
      settings and webhooks, their review, and their lifecycle (publish,
      discard, rebase).


      Pass `version: "new"` on the edit endpoints to create the draft. Use these
      when the organization requires approvals for a connection, or to group
      several changes into one publish.
  - name: visual-changesets
    x-displayName: Visual Changesets
    description: Groups of visual changes made by the visual editor to a single page
  - name: saved-groups
    x-displayName: Saved Groups
    description: >-
      Defined sets of attribute values which can be used with feature rules for
      targeting features at particular users.
  - name: saved-group-revisions
    x-displayName: Saved Group Revisions
    description: >-
      Draft revisions for saved groups, including pending changes, approvals,
      and lifecycle (publish, discard, revert).


      Most callers can interact with these endpoints via shorthand actions
      (`/items/add`, `/items/remove`, single-field PUTs) instead of authoring
      JSON Patch ops directly. Pass `version: "new"` on edit endpoints to
      auto-create a draft.
  - name: constants
    x-displayName: Constants
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Reusable named values referenced from feature flag values as `@const:key`
      and resolved into the SDK payload at build time. String constants are
      interpolated via `{{ @const:key }}`; JSON (object) constants are composed
      via an `$extends` array. A constant's own keys **replace** what its
      `$extends` bases provide, wholesale — constants are atomic building
      blocks. (Config and feature values compose as deep, targeted patches
      instead.)
  - name: constant-revisions
    x-displayName: Constant Revisions
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Draft revisions for constants, including pending changes, approvals, and
      lifecycle (publish, discard, revert). Pass `version: "new"` on edit
      endpoints to auto-create a draft.
  - name: configs
    x-displayName: Configs
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Reusable, typed, inheritable JSON objects referenced from feature flag
      values as `@config:key`. A config carries a field `schema` (with
      TypeScript/JSON Schema import-export) and a lineage `parent`. Inheritance
      is expressed via `parent`, never an in-value `@config:` entry. Values
      layer as a **deep, targeted patch**: a child (or a config-backed feature
      value) restates only the leaves it changes and inherits the rest — unlike
      a constant's `$extends`, whose own keys replace wholesale. Schema fields
      colliding with a published ancestor's key follow 'base wins': identical
      re-declarations are stripped with a warning, differing ones are rejected.
  - name: config-revisions
    x-displayName: Config Revisions
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Draft revisions for configs, including value and schema edits, schema
      import (JSON Schema / TypeScript / inferred), approvals, and lifecycle
      (publish, discard, revert). Publishing a schema change cascades the "base
      wins" normalization to descendant configs; a publish that removes or
      retypes fields descendants still use soft-blocks with a 422 unless the
      request body sets `ignoreWarnings: true`. Pass `version: "new"` on edit
      endpoints to auto-create a draft.
  - name: releases
    x-displayName: Releases
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Coordinated multi-entity publishing: publish a set of revisions across
      Feature Flags, Saved Groups, configs, and constants as one all-or-nothing
      operation, validated against the combined end-state instead of each
      in-between state. Requires the `releases` commercial feature.
  - name: custom-hooks
    x-displayName: Custom Hooks
    description: >-
      Sandboxed JavaScript validation hooks that run when features, configs, or
      their revisions are saved or published. Throwing an Error blocks the save;
      `addWarning(msg)` raises a soft warning. Hooks are scoped by projects, or
      pinned to a single feature/config via `entityType`/`entityId`; a
      config-scoped hook also runs for every config inheriting from it (its
      whole descendant lineage). Scope can be retargeted on update (or cleared
      with nulls). Requires an enterprise plan; not available on GrowthBook
      Cloud.
  - name: organizations
    x-displayName: Organizations
    description: >-
      Organizations are used for multi-org deployments where different teams can
      run their own isolated feature flags and experiments. These endpoints are
      only via a super-admin's Personal Access Token.
  - name: members
    x-displayName: Members
    description: Members are users who have been invited to an organization.
  - name: event-webhooks
    x-displayName: Event Webhooks
    description: >-
      Send GrowthBook events (feature, experiment and other changes) to your own
      endpoint.
  - name: audits
    x-displayName: Audit Logs
    description: >-
      Audit history of who changed what, and the event log that drives event
      webhooks. Requires permission to view audit logs.
  - name: code-references
    x-displayName: Code References
    description: >-
      Intended for use with our code reference CI utility,
      [`gb-find-code-refs`](https://github.com/growthbook/gb-find-code-refs).
  - name: archetypes
    x-displayName: Archetypes
    description: >-
      Archetypes allow you to simulate the result of targeting rules on pre-set
      user attributes
  - name: queries
    x-displayName: Queries
    description: Retrieve queries used in experiments to calculate results.
  - name: settings
    x-displayName: Settings
    description: Get the organization settings.
  - name: attributes
    x-displayName: Attributes
    description: Used when targeting feature flags and experiments.
  - name: usage
    x-displayName: Usage
    description: Usage information for metrics in experiments.
  - name: meta
    x-displayName: Meta
    description: >-
      Server metadata, including the running build's version and commit for
      version-skew checks.
  - name: ContextualBandits
    x-displayName: Contextual Bandits
    description: ''
  - name: information-schema-tables
    x-displayName: information-schema-tables
    description: ''
  - name: Dashboards
    x-displayName: Dashboards
    description: ''
  - name: ContextualBanditQueries
    x-displayName: Contextual Bandit Queries
    description: ''
  - name: InterleavingExposureQueries
    x-displayName: Interleaving Exposure Queries
    description: ''
  - name: Interleavings
    x-displayName: Interleaving Experiments
    description: ''
  - name: CustomFields
    x-displayName: Custom Fields
    description: ''
  - name: MetricGroups
    x-displayName: Metric Groups
    description: ''
  - name: Teams
    x-displayName: Teams
    description: ''
  - name: ExperimentTemplates
    x-displayName: Experiment Templates
    description: ''
  - name: AnalyticsExplorations
    x-displayName: Analytics Explorations
    description: ''
  - name: RampScheduleTemplates
    x-displayName: Ramp Schedule Templates
    description: Reusable step configurations for ramp schedules.
  - name: Learnings
    x-displayName: Learnings
    description: >-
      Saved learnings captured across experiments, including AI-discovered
      patterns.
  - name: Holdouts
    x-displayName: Holdouts
    description: >-
      Hold a share of traffic out of all experiments to measure their combined
      effect.
  - name: AutoRuns
    x-displayName: Auto Runs
    description: ''
  - name: Populations
    x-displayName: Populations
    description: >-
      **Beta** — these endpoints are new and may change in
      backwards-incompatible ways.


      Populations define a set of units by the steps they must complete, such as
      appearing in a fact table. Populations are not yet used in analysis.
  - name: WebhookSecrets
    x-displayName: Webhook Secrets
    description: >-
      Secrets substituted into webhook URLs and headers at send time. Values are
      set in the app and never returned.
  - name: SdkWebhooks
    x-displayName: SDK Webhooks
    description: >-
      Webhooks that fire when an SDK Connection's payload changes. Signing keys
      and headers are only returned by GET.
  - name: AdobeExperiencePlatformQueryServiceConnection_model
    x-displayName: Adobe Experience Platform Query Service Connection
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/AdobeExperiencePlatformQueryServiceConnection"
      />
  - name: AggregatedFactTable_model
    x-displayName: Aggregated Fact Table
    description: <SchemaDefinition schemaRef="#/components/schemas/AggregatedFactTable" />
  - name: AnalyticsExploration_model
    x-displayName: Analytics Exploration
    description: <SchemaDefinition schemaRef="#/components/schemas/AnalyticsExploration" />
  - name: Archetype_model
    x-displayName: Archetype
    description: <SchemaDefinition schemaRef="#/components/schemas/Archetype" />
  - name: AthenaConnection_model
    x-displayName: Athena Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/AthenaConnection" />
  - name: Attribute_model
    x-displayName: Attribute
    description: <SchemaDefinition schemaRef="#/components/schemas/Attribute" />
  - name: Audit_model
    x-displayName: Audit
    description: <SchemaDefinition schemaRef="#/components/schemas/Audit" />
  - name: AutoRun_model
    x-displayName: Auto Run
    description: <SchemaDefinition schemaRef="#/components/schemas/AutoRun" />
  - name: BigQueryConnection_model
    x-displayName: Big Query Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/BigQueryConnection" />
  - name: ClickHouseConnection_model
    x-displayName: Click House Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/ClickHouseConnection" />
  - name: CodeRef_model
    x-displayName: Code Ref
    description: <SchemaDefinition schemaRef="#/components/schemas/CodeRef" />
  - name: Config_model
    x-displayName: Config
    description: <SchemaDefinition schemaRef="#/components/schemas/Config" />
  - name: ConfigKeyUsage_model
    x-displayName: Config Key Usage
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigKeyUsage" />
  - name: ConfigLineage_model
    x-displayName: Config Lineage
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigLineage" />
  - name: ConfigReferences_model
    x-displayName: Config References
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigReferences" />
  - name: ConfigRevision_model
    x-displayName: Config Revision
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigRevision" />
  - name: ConfigRevisionActivityLogEntry_model
    x-displayName: Config Revision Activity Log Entry
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ConfigRevisionActivityLogEntry" />
  - name: ConfigRevisionRef_model
    x-displayName: Config Revision Ref
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigRevisionRef" />
  - name: ConfigRevisionReview_model
    x-displayName: Config Revision Review
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigRevisionReview" />
  - name: ConfigSchemaExport_model
    x-displayName: Config Schema Export
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigSchemaExport" />
  - name: ConfigSchemaSource_model
    x-displayName: Config Schema Source
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigSchemaSource" />
  - name: ConfigSchemaVerify_model
    x-displayName: Config Schema Verify
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigSchemaVerify" />
  - name: ConfigSchemaWarning_model
    x-displayName: Config Schema Warning
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfigSchemaWarning" />
  - name: Confirmation_model
    x-displayName: Confirmation
    description: <SchemaDefinition schemaRef="#/components/schemas/Confirmation" />
  - name: ConfirmationHeld_model
    x-displayName: Confirmation Held
    description: <SchemaDefinition schemaRef="#/components/schemas/ConfirmationHeld" />
  - name: Constant_model
    x-displayName: Constant
    description: <SchemaDefinition schemaRef="#/components/schemas/Constant" />
  - name: ConstantReferences_model
    x-displayName: Constant References
    description: <SchemaDefinition schemaRef="#/components/schemas/ConstantReferences" />
  - name: ConstantRevision_model
    x-displayName: Constant Revision
    description: <SchemaDefinition schemaRef="#/components/schemas/ConstantRevision" />
  - name: ConstantRevisionActivityLogEntry_model
    x-displayName: Constant Revision Activity Log Entry
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ConstantRevisionActivityLogEntry" />
  - name: ConstantRevisionRef_model
    x-displayName: Constant Revision Ref
    description: <SchemaDefinition schemaRef="#/components/schemas/ConstantRevisionRef" />
  - name: ConstantRevisionReview_model
    x-displayName: Constant Revision Review
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/ConstantRevisionReview"
      />
  - name: ContextualBandit_model
    x-displayName: Contextual Bandit
    description: <SchemaDefinition schemaRef="#/components/schemas/ContextualBandit" />
  - name: ContextualBanditQuery_model
    x-displayName: Contextual Bandit Query
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/ContextualBanditQuery"
      />
  - name: CustomField_model
    x-displayName: Custom Field
    description: <SchemaDefinition schemaRef="#/components/schemas/CustomField" />
  - name: CustomHook_model
    x-displayName: Custom Hook
    description: <SchemaDefinition schemaRef="#/components/schemas/CustomHook" />
  - name: Dashboard_model
    x-displayName: Dashboard
    description: <SchemaDefinition schemaRef="#/components/schemas/Dashboard" />
  - name: DataSource_model
    x-displayName: Data Source
    description: <SchemaDefinition schemaRef="#/components/schemas/DataSource" />
  - name: DatabricksConnection_model
    x-displayName: Databricks Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/DatabricksConnection" />
  - name: Dimension_model
    x-displayName: Dimension
    description: <SchemaDefinition schemaRef="#/components/schemas/Dimension" />
  - name: Environment_model
    x-displayName: Environment
    description: <SchemaDefinition schemaRef="#/components/schemas/Environment" />
  - name: Event_model
    x-displayName: Event
    description: <SchemaDefinition schemaRef="#/components/schemas/Event" />
  - name: EventUser_model
    x-displayName: Event User
    description: <SchemaDefinition schemaRef="#/components/schemas/EventUser" />
  - name: EventWebhook_model
    x-displayName: Event Webhook
    description: <SchemaDefinition schemaRef="#/components/schemas/EventWebhook" />
  - name: EventWebhookLog_model
    x-displayName: Event Webhook Log
    description: <SchemaDefinition schemaRef="#/components/schemas/EventWebhookLog" />
  - name: Experiment_model
    x-displayName: Experiment
    description: <SchemaDefinition schemaRef="#/components/schemas/Experiment" />
  - name: Experiment Rule_model
    x-displayName: Experiment Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/Experiment Rule" />
  - name: ExperimentAnalysisSettings_model
    x-displayName: Experiment Analysis Settings
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ExperimentAnalysisSettings" />
  - name: ExperimentDecisionFrameworkSettings_model
    x-displayName: Experiment Decision Framework Settings
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ExperimentDecisionFrameworkSettings" />
  - name: ExperimentMetric_model
    x-displayName: Experiment Metric
    description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentMetric" />
  - name: ExperimentMetricOverrideEntry_model
    x-displayName: Experiment Metric Override Entry
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ExperimentMetricOverrideEntry" />
  - name: ExperimentResults_model
    x-displayName: Experiment Results
    description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentResults" />
  - name: ExperimentSnapshot_model
    x-displayName: Experiment Snapshot
    description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentSnapshot" />
  - name: ExperimentTemplate_model
    x-displayName: Experiment Template
    description: <SchemaDefinition schemaRef="#/components/schemas/ExperimentTemplate" />
  - name: ExperimentWithEnhancedStatus_model
    x-displayName: Experiment With Enhanced Status
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/ExperimentWithEnhancedStatus" />
  - name: FactMetric_model
    x-displayName: Fact Metric
    description: <SchemaDefinition schemaRef="#/components/schemas/FactMetric" />
  - name: FactTable_model
    x-displayName: Fact Table
    description: <SchemaDefinition schemaRef="#/components/schemas/FactTable" />
  - name: FactTableColumn_model
    x-displayName: Fact Table Column
    description: <SchemaDefinition schemaRef="#/components/schemas/FactTableColumn" />
  - name: FactTableFilter_model
    x-displayName: Fact Table Filter
    description: <SchemaDefinition schemaRef="#/components/schemas/FactTableFilter" />
  - name: FeatureBaseRule_model
    x-displayName: Feature Base Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureBaseRule" />
  - name: FeatureContextualBanditRefRule_model
    x-displayName: Feature Contextual Bandit Ref Rule
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/FeatureContextualBanditRefRule" />
  - name: FeatureDefinition_model
    x-displayName: Feature Definition
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureDefinition" />
  - name: FeatureEnvironmentV1_model
    x-displayName: Feature Environment V1
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureEnvironmentV1" />
  - name: FeatureEnvironmentV2_model
    x-displayName: Feature Environment V2
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureEnvironmentV2" />
  - name: FeatureExperimentRefRule_model
    x-displayName: Feature Experiment Ref Rule
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/FeatureExperimentRefRule" />
  - name: FeatureExperimentRule_model
    x-displayName: Feature Experiment Rule
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/FeatureExperimentRule"
      />
  - name: FeatureForceRule_model
    x-displayName: Feature Force Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureForceRule" />
  - name: FeatureRevisionRef_model
    x-displayName: Feature Revision Ref
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRevisionRef" />
  - name: FeatureRevisionSummary_model
    x-displayName: Feature Revision Summary
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/FeatureRevisionSummary"
      />
  - name: FeatureRevisionV1_model
    x-displayName: Feature Revision V1
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRevisionV1" />
  - name: FeatureRevisionV2_model
    x-displayName: Feature Revision V2
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRevisionV2" />
  - name: FeatureRolloutRule_model
    x-displayName: Feature Rollout Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRolloutRule" />
  - name: FeatureRuleV1_model
    x-displayName: Feature Rule V1
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRuleV1" />
  - name: FeatureRuleV2_model
    x-displayName: Feature Rule V2
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureRuleV2" />
  - name: FeatureSafeRolloutRule_model
    x-displayName: Feature Safe Rollout Rule
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/FeatureSafeRolloutRule"
      />
  - name: FeatureV1_model
    x-displayName: Feature V1
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureV1" />
  - name: FeatureV2_model
    x-displayName: Feature V2
    description: <SchemaDefinition schemaRef="#/components/schemas/FeatureV2" />
  - name: FeatureWithRevisionsV1_model
    x-displayName: Feature With Revisions V1
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/FeatureWithRevisionsV1"
      />
  - name: FeatureWithRevisionsV2_model
    x-displayName: Feature With Revisions V2
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/FeatureWithRevisionsV2"
      />
  - name: Holdout_model
    x-displayName: Holdout
    description: <SchemaDefinition schemaRef="#/components/schemas/Holdout" />
  - name: InformationSchema_model
    x-displayName: Information Schema
    description: <SchemaDefinition schemaRef="#/components/schemas/InformationSchema" />
  - name: InformationSchemaTable_model
    x-displayName: Information Schema Table
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/InformationSchemaTable"
      />
  - name: Interleaving_model
    x-displayName: Interleaving
    description: <SchemaDefinition schemaRef="#/components/schemas/Interleaving" />
  - name: InterleavingExposureQuery_model
    x-displayName: Interleaving Exposure Query
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/InterleavingExposureQuery" />
  - name: InterleavingSnapshot_model
    x-displayName: Interleaving Snapshot
    description: <SchemaDefinition schemaRef="#/components/schemas/InterleavingSnapshot" />
  - name: InterleavingSnapshotStatus_model
    x-displayName: Interleaving Snapshot Status
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/InterleavingSnapshotStatus" />
  - name: Learning_model
    x-displayName: Learning
    description: <SchemaDefinition schemaRef="#/components/schemas/Learning" />
  - name: LookbackOverride_model
    x-displayName: Lookback Override
    description: <SchemaDefinition schemaRef="#/components/schemas/LookbackOverride" />
  - name: Member_model
    x-displayName: Member
    description: <SchemaDefinition schemaRef="#/components/schemas/Member" />
  - name: Metric_model
    x-displayName: Metric
    description: <SchemaDefinition schemaRef="#/components/schemas/Metric" />
  - name: MetricAnalysis_model
    x-displayName: Metric Analysis
    description: <SchemaDefinition schemaRef="#/components/schemas/MetricAnalysis" />
  - name: MetricGroup_model
    x-displayName: Metric Group
    description: <SchemaDefinition schemaRef="#/components/schemas/MetricGroup" />
  - name: MetricUsage_model
    x-displayName: Metric Usage
    description: <SchemaDefinition schemaRef="#/components/schemas/MetricUsage" />
  - name: MixpanelConnection_model
    x-displayName: Mixpanel Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/MixpanelConnection" />
  - name: MssqlConnection_model
    x-displayName: Mssql Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/MssqlConnection" />
  - name: MysqlConnection_model
    x-displayName: Mysql Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/MysqlConnection" />
  - name: Namespace_model
    x-displayName: Namespace
    description: <SchemaDefinition schemaRef="#/components/schemas/Namespace" />
  - name: NamespaceExperimentMember_model
    x-displayName: Namespace Experiment Member
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/NamespaceExperimentMember" />
  - name: Organization_model
    x-displayName: Organization
    description: <SchemaDefinition schemaRef="#/components/schemas/Organization" />
  - name: PaginationFields_model
    x-displayName: Pagination Fields
    description: <SchemaDefinition schemaRef="#/components/schemas/PaginationFields" />
  - name: Population_model
    x-displayName: Population
    description: <SchemaDefinition schemaRef="#/components/schemas/Population" />
  - name: PostgresConnection_model
    x-displayName: Postgres Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/PostgresConnection" />
  - name: PrestoConnection_model
    x-displayName: Presto Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/PrestoConnection" />
  - name: Project_model
    x-displayName: Project
    description: <SchemaDefinition schemaRef="#/components/schemas/Project" />
  - name: Query_model
    x-displayName: Query
    description: <SchemaDefinition schemaRef="#/components/schemas/Query" />
  - name: RampSchedule_model
    x-displayName: Ramp Schedule
    description: <SchemaDefinition schemaRef="#/components/schemas/RampSchedule" />
  - name: RampScheduleTemplate_model
    x-displayName: Ramp Schedule Template
    description: <SchemaDefinition schemaRef="#/components/schemas/RampScheduleTemplate" />
  - name: RedshiftConnection_model
    x-displayName: Redshift Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/RedshiftConnection" />
  - name: Report_model
    x-displayName: Report
    description: <SchemaDefinition schemaRef="#/components/schemas/Report" />
  - name: RequireReviewRule_model
    x-displayName: Require Review Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/RequireReviewRule" />
  - name: RequireReviewRuleInput_model
    x-displayName: Require Review Rule Input
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/RequireReviewRuleInput"
      />
  - name: RevisionIdRef_model
    x-displayName: Revision Id Ref
    description: <SchemaDefinition schemaRef="#/components/schemas/RevisionIdRef" />
  - name: Safe Rollout Rule_model
    x-displayName: Safe Rollout Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/Safe Rollout Rule" />
  - name: SavedGroup_model
    x-displayName: Saved Group
    description: <SchemaDefinition schemaRef="#/components/schemas/SavedGroup" />
  - name: SavedGroupApprovalRule_model
    x-displayName: Saved Group Approval Rule
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/SavedGroupApprovalRule"
      />
  - name: SavedGroupReferenceResource_model
    x-displayName: Saved Group Reference Resource
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SavedGroupReferenceResource" />
  - name: SavedGroupReferences_model
    x-displayName: Saved Group References
    description: <SchemaDefinition schemaRef="#/components/schemas/SavedGroupReferences" />
  - name: SavedGroupRevision_model
    x-displayName: Saved Group Revision
    description: <SchemaDefinition schemaRef="#/components/schemas/SavedGroupRevision" />
  - name: SavedGroupRevisionActivityLogEntry_model
    x-displayName: Saved Group Revision Activity Log Entry
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SavedGroupRevisionActivityLogEntry" />
  - name: SavedGroupRevisionRef_model
    x-displayName: Saved Group Revision Ref
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/SavedGroupRevisionRef"
      />
  - name: SavedGroupRevisionReview_model
    x-displayName: Saved Group Revision Review
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SavedGroupRevisionReview" />
  - name: SavedGroupUpload_model
    x-displayName: Saved Group Upload
    description: <SchemaDefinition schemaRef="#/components/schemas/SavedGroupUpload" />
  - name: ScheduleRule_model
    x-displayName: Schedule Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/ScheduleRule" />
  - name: ScheduledStopPlan_model
    x-displayName: Scheduled Stop Plan
    description: <SchemaDefinition schemaRef="#/components/schemas/ScheduledStopPlan" />
  - name: SdkConnection_model
    x-displayName: Sdk Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/SdkConnection" />
  - name: SdkConnectionApprovalRule_model
    x-displayName: Sdk Connection Approval Rule
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionApprovalRule" />
  - name: SdkConnectionRevision_model
    x-displayName: Sdk Connection Revision
    description: >-
      <SchemaDefinition schemaRef="#/components/schemas/SdkConnectionRevision"
      />
  - name: SdkConnectionRevisionActivityLogEntry_model
    x-displayName: Sdk Connection Revision Activity Log Entry
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionRevisionActivityLogEntry" />
  - name: SdkConnectionRevisionRef_model
    x-displayName: Sdk Connection Revision Ref
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionRevisionRef" />
  - name: SdkConnectionRevisionReview_model
    x-displayName: Sdk Connection Revision Review
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionRevisionReview" />
  - name: SdkConnectionRevisionSettings_model
    x-displayName: Sdk Connection Revision Settings
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionRevisionSettings" />
  - name: SdkConnectionRevisionWebhook_model
    x-displayName: Sdk Connection Revision Webhook
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/SdkConnectionRevisionWebhook" />
  - name: SdkWebhook_model
    x-displayName: Sdk Webhook
    description: <SchemaDefinition schemaRef="#/components/schemas/SdkWebhook" />
  - name: Segment_model
    x-displayName: Segment
    description: <SchemaDefinition schemaRef="#/components/schemas/Segment" />
  - name: Settings_model
    x-displayName: Settings
    description: <SchemaDefinition schemaRef="#/components/schemas/Settings" />
  - name: SnowflakeConnection_model
    x-displayName: Snowflake Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/SnowflakeConnection" />
  - name: Targeting Rule_model
    x-displayName: Targeting Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/Targeting Rule" />
  - name: TargetingReviewRule_model
    x-displayName: Targeting Review Rule
    description: <SchemaDefinition schemaRef="#/components/schemas/TargetingReviewRule" />
  - name: Team_model
    x-displayName: Team
    description: <SchemaDefinition schemaRef="#/components/schemas/Team" />
  - name: VerticaConnection_model
    x-displayName: Vertica Connection
    description: <SchemaDefinition schemaRef="#/components/schemas/VerticaConnection" />
  - name: VisualChange_model
    x-displayName: Visual Change
    description: <SchemaDefinition schemaRef="#/components/schemas/VisualChange" />
  - name: VisualChangeset_model
    x-displayName: Visual Changeset
    description: <SchemaDefinition schemaRef="#/components/schemas/VisualChangeset" />
  - name: VisualEditorCbExperimentStub_model
    x-displayName: Visual Editor Cb Experiment Stub
    description: >-
      <SchemaDefinition
      schemaRef="#/components/schemas/VisualEditorCbExperimentStub" />
  - name: WebhookSecret_model
    x-displayName: Webhook Secret
    description: <SchemaDefinition schemaRef="#/components/schemas/WebhookSecret" />
paths:
  /v1/experiments/{id}/archive:
    post:
      tags:
        - experiments
      summary: Archive an experiment
      description: >-
        An archived experiment leaves the SDK payload. Refused while a running
        experiment or a temporary rollout still serves through linked changes
        unless `linkedChanges` says what happens to them.
      operationId: postExperimentArchive
      parameters:
        - $ref: '#/components/parameters/id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                linkedChanges:
                  description: >-
                    Required while the experiment still serves through linked
                    changes. "materialize" keeps a stopped experiment's released
                    variation as a permanent force rule on each linked Feature
                    Flag; "remove" acknowledges that the linked changes stop
                    serving.
                  type: string
                  enum:
                    - materialize
                    - remove
              additionalProperties: false
      responses:
        '200':
          description: Resource created
          content:
            application/json:
              schema:
                type: object
                properties:
                  experiment:
                    $ref: '#/components/schemas/ExperimentWithEnhancedStatus'
                required:
                  - experiment
                additionalProperties: false
        '202':
          $ref: '#/components/responses/ConfirmationHeld'
      x-codeSamples:
        - lang: cURL
          source: >-
            curl -X POST
            'https://api.growthbook.io/api/v1/experiments/{id}/archive' \
              -H 'Authorization: Bearer YOUR_API_KEY'
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      description: The id of the requested resource
      schema:
        type: string
        description: The id of the requested resource
  schemas:
    ExperimentWithEnhancedStatus:
      type: object
      properties:
        id:
          type: string
        trackingKey:
          type: string
        dateCreated:
          type: string
          format: date-time
        dateUpdated:
          type: string
          format: date-time
        name:
          type: string
        type:
          type: string
          enum:
            - standard
            - multi-armed-bandit
            - holdout
        project:
          type: string
        hypothesis:
          type: string
        description:
          type: string
          maxLength: 10000
        tags:
          type: array
          items:
            type: string
        owner:
          type: string
          description: >-
            The userId of the owner (or raw owner name/email for legacy
            records). An owner set by email comes back here as its userId;
            compare against `ownerEmail` instead.
        ownerEmail:
          description: >-
            The email address of the owner, when the owner can be resolved to a
            known user. Matches an `owner` that was sent as an email address.
          type: string
        archived:
          type: boolean
        status:
          type: string
        autoRefresh:
          type: boolean
        hashAttribute:
          type: string
        fallbackAttribute:
          type: string
        hashVersion:
          anyOf:
            - type: number
              const: 1
            - type: number
              const: 2
        disableStickyBucketing:
          type: boolean
        bucketVersion:
          type: number
        minBucketVersion:
          type: number
        variations:
          type: array
          items:
            type: object
            properties:
              variationId:
                type: string
              key:
                type: string
              name:
                type: string
              description:
                type: string
                maxLength: 10000
              screenshots:
                type: array
                items:
                  type: string
            required:
              - variationId
              - key
              - name
              - description
              - screenshots
            additionalProperties: false
        phases:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              dateStarted:
                type: string
              dateEnded:
                type: string
              reasonForStopping:
                type: string
              seed:
                type: string
              coverage:
                type: number
              trafficSplit:
                type: array
                items:
                  type: object
                  properties:
                    variationId:
                      type: string
                    weight:
                      type: number
                  required:
                    - variationId
                    - weight
                  additionalProperties: false
              namespace:
                type: object
                properties:
                  namespaceId:
                    type: string
                  enabled:
                    type: boolean
                  range:
                    minItems: 2
                    maxItems: 2
                    type: array
                    items:
                      type: number
                  ranges:
                    type: array
                    items:
                      type: array
                      prefixItems:
                        - type: number
                        - type: number
                      items: false
                      minItems: 2
                      maxItems: 2
                required:
                  - namespaceId
                additionalProperties: false
              targetingCondition:
                type: string
              prerequisites:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    condition:
                      type: string
                  required:
                    - id
                    - condition
                  additionalProperties: false
              savedGroupTargeting:
                type: array
                items:
                  type: object
                  properties:
                    matchType:
                      type: string
                      enum:
                        - all
                        - any
                        - none
                    savedGroups:
                      type: array
                      items:
                        type: string
                  required:
                    - matchType
                    - savedGroups
                  additionalProperties: false
            required:
              - name
              - dateStarted
              - dateEnded
              - reasonForStopping
              - seed
              - coverage
              - trafficSplit
              - targetingCondition
            additionalProperties: false
        settings:
          $ref: '#/components/schemas/ExperimentAnalysisSettings'
        resultSummary:
          type: object
          properties:
            status:
              type: string
            winner:
              type: string
            conclusions:
              type: string
            releasedVariationId:
              type: string
            excludeFromPayload:
              type: boolean
          required:
            - status
            - winner
            - conclusions
            - releasedVariationId
            - excludeFromPayload
          additionalProperties: false
        shareLevel:
          type: string
          enum:
            - public
            - organization
        publicUrl:
          type: string
        banditScheduleValue:
          type: number
        banditScheduleUnit:
          type: string
          enum:
            - days
            - hours
        banditBurnInValue:
          type: number
        banditBurnInUnit:
          type: string
          enum:
            - days
            - hours
        banditConversionWindowValue:
          type: number
        banditConversionWindowUnit:
          type: string
          enum:
            - days
            - hours
        linkedFeatures:
          type: array
          items:
            type: string
        attributeScopeAllProjects:
          type: boolean
        hasVisualChangesets:
          type: boolean
        hasURLRedirects:
          type: boolean
        customFields:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        customMetricSlices:
          type: array
          items:
            type: object
            properties:
              slices:
                type: array
                items:
                  type: object
                  properties:
                    column:
                      type: string
                    levels:
                      type: array
                      items:
                        type: string
                  required:
                    - column
                    - levels
                  additionalProperties: false
            required:
              - slices
            additionalProperties: false
          description: Custom slices that apply to ALL applicable metrics in the experiment
        precomputedUnitDimensionIds:
          maxItems: 3
          type: array
          items:
            type: string
        defaultDashboardId:
          type: string
          description: ID of the default dashboard for this experiment.
        templateId:
          type: string
        statusUpdateSchedule:
          anyOf:
            - type: object
              properties:
                startAt:
                  description: >-
                    ISO datetime when the experiment should start. Must be in
                    the future. Setting or clearing this field invalidates any
                    existing staged start (`nextScheduledStatusUpdate`); call
                    POST /experiments/{id}/start to stage the new schedule.
                  type: string
                  format: date-time
                stopAt:
                  description: >-
                    ISO datetime when the experiment should stop. Resolved from
                    `stopAfter` at start when a relative end was set.
                  type: string
                  format: date-time
                stopAfter:
                  type: object
                  properties:
                    value:
                      type: integer
                      exclusiveMinimum: 0
                    unit:
                      type: string
                      enum:
                        - hours
                        - days
                  required:
                    - value
                    - unit
                  additionalProperties: false
                  description: >-
                    Relative end offset. Deferred: resolved to a concrete
                    `stopAt` at the experiment's actual start (or off
                    `dateStarted` when already running).
                scheduledStopPlan:
                  $ref: '#/components/schemas/ScheduledStopPlan'
                  description: >-
                    End-of-experiment automation applied at the scheduled end.
                    Required whenever a `stopAt` or `stopAfter` is set (any
                    mode, including `notify`).
              additionalProperties: false
              description: >-
                Scheduled start/end for an experiment. All fields optional; the
                end may be an absolute `stopAt` or a deferred relative
                `stopAfter`, but not both.
            - type: 'null'
        nextScheduledStatusUpdate:
          anyOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - start
                    - stop
                date:
                  type: string
                  format: date-time
              required:
                - type
                - date
              additionalProperties: false
            - type: 'null'
        enhancedStatus:
          type: object
          properties:
            status:
              type: string
              enum:
                - Running
                - Stopped
                - Draft
                - Scheduled
                - Archived
            detailedStatus:
              type: string
            needsAttention:
              description: Whether the app flags this experiment as needing attention.
              type: boolean
            decision:
              type: object
              properties:
                category:
                  type: string
                  enum:
                    - ready-for-action
                    - has-issue
                    - collecting-data
                  description: >-
                    What `status` asks of you. `ready-for-action`: the results
                    are ready to act on (`ship-now`, `rollback-now`,
                    `ready-for-review`, `scheduled-end-review`). `has-issue`:
                    something needs fixing before the results can be trusted
                    (`unhealthy`, `data-incomplete`, `no-data`).
                    `collecting-data`: keep the experiment running (`days-left`,
                    `before-min-duration`).
                status:
                  type: string
                  enum:
                    - ship-now
                    - rollback-now
                    - ready-for-review
                    - scheduled-end-review
                    - days-left
                    - before-min-duration
                    - no-data
                    - unhealthy
                    - data-incomplete
                  description: >-
                    `ship-now`, `rollback-now` and `ready-for-review` are
                    recommendations from the Experiment Decision Framework and
                    are only rendered if the Decision Framework is enabled for
                    your organization. `unhealthy` means a health check is
                    failing (see `healthIssues`). `data-incomplete` means some
                    metrics could not be computed (see `erroredMetricIds`).
                    `days-left` and `before-min-duration` mean the experiment
                    should keep running. `scheduled-end-review` means the
                    scheduled end date passed without a recommendation.
                reason:
                  description: Explanation of the status, as shown in the app.
                  type: string
                daysLeft:
                  description: >-
                    Days until the scheduled end date or, without one, until the
                    experiment is expected to reach its target power. Set when
                    `status` is `days-left`. null when the experiment is not
                    expected to reach its target power at the current traffic.
                  type:
                    - number
                    - 'null'
                variations:
                  description: >-
                    Variations the recommendation applies to. Set for
                    `ship-now`, `rollback-now` and `ready-for-review`.
                  type: array
                  items:
                    type: object
                    properties:
                      variationId:
                        type: string
                      action:
                        anyOf:
                          - type: string
                            enum:
                              - ship
                              - rollback
                              - review
                          - type: 'null'
                        description: >-
                          Action the decision criteria reached for this
                          variation. null when no rule applied.
                    required:
                      - variationId
                      - action
                    additionalProperties: false
                healthIssues:
                  description: >-
                    What is wrong with the experiment. Set when `status` is
                    `unhealthy`. The results endpoint has the numbers behind
                    each one under `result.health`: `sample-ratio-mismatch` in
                    `srm`, `multiple-exposures` in `multipleExposures`,
                    `low-power` in `power`, `covariate-imbalance` in
                    `covariateImbalance`, `mixed-cluster-assignment` in
                    `cluster.mixedAssignment` and `units-in-multiple-clusters`
                    in `cluster.unitsInMultipleClusters`.
                  type: array
                  items:
                    type: string
                    enum:
                      - sample-ratio-mismatch
                      - multiple-exposures
                      - low-power
                      - covariate-imbalance
                      - mixed-cluster-assignment
                      - units-in-multiple-clusters
                erroredMetricIds:
                  description: >-
                    Metrics that could not be computed. Set when `status` is
                    `data-incomplete`.
                  type: array
                  items:
                    type: string
              required:
                - category
                - status
              additionalProperties: false
              description: >-
                The decision behind `detailedStatus` for a running experiment,
                based on the latest successful standard snapshot of the latest
                phase. Omitted when there is nothing to report yet.
          required:
            - status
          additionalProperties: false
      required:
        - id
        - trackingKey
        - dateCreated
        - dateUpdated
        - name
        - type
        - project
        - hypothesis
        - description
        - tags
        - owner
        - archived
        - status
        - autoRefresh
        - hashAttribute
        - hashVersion
        - variations
        - phases
        - settings
      additionalProperties: false
    ExperimentAnalysisSettings:
      type: object
      properties:
        datasourceId:
          type: string
        assignmentQuery:
          type: object
          properties:
            id:
              type: string
              description: The ID of one of the data source's assignment queries.
            identifierType:
              description: >-
                The identifier type analyzed on. Null when none can be resolved:
                no assignment query is selected, or a record saved before
                identifier types were stored points at a query that no longer
                exists.
              type:
                - string
                - 'null'
          required:
            - id
            - identifierType
          additionalProperties: false
          description: >-
            The assignment query, grouping its ID with the identifier type
            analyzed on.
        assignmentQueryId:
          type: string
          description: 'Deprecated: use `assignmentQuery`.'
          deprecated: true
        isClusterExperiment:
          type: boolean
          description: >-
            Whether this is a cluster-randomized experiment (randomized on the
            assignment query's identifier type, analyzed on
            clusterSubUnitIdentifier).
        clusterSubUnitIdentifier:
          type: string
          description: >-
            For cluster experiments, the nested sub-unit identifier type
            analyzed within each cluster (e.g. user_id).
        experimentId:
          type: string
        segmentId:
          type: string
        queryFilter:
          type: string
        inProgressConversions:
          type: string
          enum:
            - include
            - exclude
        attributionModel:
          type: string
          enum:
            - firstExposure
            - experimentDuration
            - lookbackOverride
          description: >-
            Setting attribution model to `"experimentDuration"` is the same as
            selecting "Ignore Conversion Windows" for the Conversion Window
            Override. Setting it to `"lookbackOverride"` requires a
            `lookbackOverride` object to be provided.
        lookbackOverride:
          $ref: '#/components/schemas/LookbackOverride'
        statsEngine:
          type: string
          enum:
            - bayesian
            - frequentist
        regressionAdjustmentEnabled:
          type: boolean
        sequentialTestingEnabled:
          type: boolean
        sequentialTestingTuningParameter:
          type: number
        postStratificationEnabled:
          anyOf:
            - type: boolean
              description: When null, the organization default is used.
            - type: 'null'
              description: When null, the organization default is used.
          description: When null, the organization default is used.
        decisionFrameworkSettings:
          $ref: '#/components/schemas/ExperimentDecisionFrameworkSettings'
          description: >-
            Controls the decision framework and metric overrides for the
            experiment. Replaces the entire stored object on update (does not
            patch individual fields).
        metricOverrides:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentMetricOverrideEntry'
          description: >-
            Per-metric analysis overrides; also reflected in
            goals/secondaryMetrics/guardrails overrides when applicable. On
            create/update, this replaces the entire stored array (it does not
            patch individual entries).
        goals:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentMetric'
        secondaryMetrics:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentMetric'
        guardrails:
          type: array
          items:
            $ref: '#/components/schemas/ExperimentMetric'
        activationMetric:
          $ref: '#/components/schemas/ExperimentMetric'
      required:
        - datasourceId
        - assignmentQuery
        - assignmentQueryId
        - experimentId
        - segmentId
        - queryFilter
        - inProgressConversions
        - attributionModel
        - statsEngine
        - goals
        - secondaryMetrics
        - guardrails
      additionalProperties: false
    ScheduledStopPlan:
      type: object
      properties:
        mode:
          type: string
          enum:
            - notify
            - auto-ship
            - force-ship
            - stop
        tiebreakerMetricId:
          type: string
        fallback:
          type: string
          enum:
            - notify
            - force-ship
          description: >-
            What to do at the scheduled end when there is no clear winner.
            Required when `mode` is `"auto-ship"`; ignored for other modes.
        fallbackVariationId:
          type: string
      required:
        - mode
      additionalProperties: false
      description: >-
        What happens at the scheduled end date. `notify` keeps the experiment
        running and just notifies (soft). `auto-ship` (requires the Decision
        Framework) ships the winning variation and stops; multi-winner ties
        break on `tiebreakerMetricId` (higher lift); with no clear winner,
        `fallback` either keeps running (`notify`) or ships
        `fallbackVariationId`. `force-ship` stops and rolls out
        `fallbackVariationId`. `stop` is a hard deadline that stops with no
        rollout. For `force-ship` and `stop`, the Decision Framework verdict
        (won/lost/inconclusive) is recorded as metadata when available.
    ConfirmationHeld:
      type: object
      properties:
        confirmation:
          $ref: '#/components/schemas/Confirmation'
        message:
          type: string
      required:
        - confirmation
        - message
      additionalProperties: false
    LookbackOverride:
      type: object
      properties:
        type:
          type: string
          enum:
            - date
            - window
        value:
          anyOf:
            - type: number
              description: >-
                For "window" type - non-negative numeric value (e.g. 7 for 7
                days). For "date" type a date string.
            - type: string
              format: date-time
              description: >-
                For "window" type - non-negative numeric value (e.g. 7 for 7
                days). For "date" type a date string.
          description: >-
            For "window" type - non-negative numeric value (e.g. 7 for 7 days).
            For "date" type a date string.
        valueUnit:
          type: string
          enum:
            - minutes
            - hours
            - days
            - weeks
          description: Used when type is "window". Defaults to "days".
      required:
        - type
        - value
      additionalProperties: false
      description: >-
        Controls the lookback override for the experiment. For type "window",
        value must be a non-negative number and valueUnit is required.
    ExperimentDecisionFrameworkSettings:
      type: object
      properties:
        decisionCriteriaId:
          type: string
        decisionFrameworkMetricOverrides:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: ID of the metric to override settings for.
              targetMDE:
                type: number
                exclusiveMinimum: 0
                description: >-
                  The target relative MDE to use for the metric, expressed as
                  proportions (e.g. use 0.1 for 10%). Must be greater than 0.
            required:
              - id
            additionalProperties: false
      additionalProperties: false
      description: >-
        Controls the decision framework and metric overrides for the experiment.
        Replaces the entire stored object on update (does not patch individual
        fields).
    ExperimentMetricOverrideEntry:
      type: object
      properties:
        id:
          type: string
          description: ID of the metric to override settings for.
        windowType:
          type: string
          enum:
            - conversion
            - lookback
            - ''
        windowHours:
          type: number
        delayHours:
          type: number
        properPriorOverride:
          type: boolean
          description: >-
            Must be true for the override to take effect. If true, the other
            proper prior settings in this object will be used if present.
        properPriorEnabled:
          type: boolean
        properPriorMean:
          type: number
        properPriorStdDev:
          type: number
        regressionAdjustmentOverride:
          type: boolean
          description: >-
            Must be true for the override to take effect. If true, the other
            regression adjustment settings in this object will be used if
            present.
        regressionAdjustmentEnabled:
          type: boolean
        regressionAdjustmentDays:
          type: number
      required:
        - id
      additionalProperties: false
      description: >-
        Per-metric analysis overrides stored on the experiment (matches internal
        metricOverrides).
    ExperimentMetric:
      type: object
      properties:
        metricId:
          type: string
        overrides:
          type: object
          properties:
            delayHours:
              type: number
            windowHours:
              type: number
            window:
              type: string
              enum:
                - conversion
                - lookback
                - ''
            properPriorOverride:
              type: boolean
            properPriorEnabled:
              type: boolean
            properPriorMean:
              type: number
            properPriorStdDev:
              type: number
            regressionAdjustmentOverride:
              type: boolean
            regressionAdjustmentEnabled:
              type: boolean
            regressionAdjustmentDays:
              type: number
            winRiskThreshold:
              deprecated: true
              type: number
              description: No longer used. Never returned.
            loseRiskThreshold:
              deprecated: true
              type: number
              description: No longer used. Never returned.
          additionalProperties: false
      required:
        - metricId
        - overrides
      additionalProperties: false
    Confirmation:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - rejected
            - expired
        actions:
          type: array
          items:
            type: object
            properties:
              action:
                type: string
                enum:
                  - feature.create
                  - feature.draft
                  - feature.review
                  - feature.publish
                  - feature.archive
                  - feature.delete
                  - feature.other
                  - experiment.create
                  - experiment.draft
                  - experiment.start
                  - experiment.stop
                  - experiment.targeting
                  - experiment.traffic
                  - experiment.phases
                  - experiment.visualEditor
                  - experiment.checklist
                  - experiment.other
                  - savedGroup.create
                  - savedGroup.draft
                  - savedGroup.review
                  - savedGroup.publish
                  - savedGroup.archive
                  - savedGroup.delete
                  - savedGroup.other
                  - constant.create
                  - constant.draft
                  - constant.review
                  - constant.publish
                  - constant.archive
                  - constant.delete
                  - constant.other
                  - config.create
                  - config.draft
                  - config.review
                  - config.publish
                  - config.archive
                  - config.delete
                  - config.other
                  - rampSchedule.create
                  - rampSchedule.start
                  - rampSchedule.pause
                  - rampSchedule.progression
                  - rampSchedule.approve
                  - rampSchedule.edit
                  - rampSchedule.delete
                  - rampSchedule.other
                  - settings.approvals
                  - settings.dataSources
                  - settings.webhooks
                  - settings.other
                  - access.members
                  - access.teams
                  - customHook.create
                  - customHook.edit
                  - customHook.delete
                  - environment.create
                  - environment.edit
                  - environment.delete
                  - project.create
                  - project.edit
                  - project.delete
                  - attribute.create
                  - attribute.edit
                  - attribute.delete
                  - customField.create
                  - customField.edit
                  - customField.delete
                  - sdkConnection.create
                  - sdkConnection.draft
                  - sdkConnection.review
                  - sdkConnection.edit
                  - sdkConnection.delete
                  - metric.create
                  - metric.edit
                  - metric.delete
                  - factTable.create
                  - factTable.edit
                  - factTable.delete
                  - segment.create
                  - segment.edit
                  - segment.delete
                  - dimension.create
                  - dimension.edit
                  - dimension.delete
                  - override.ignoreWarnings
                  - override.skipSchemaValidation
                  - override.skipHooks
                  - override.bypassApproval
                  - override.restBypassesReviews
                  - override.draftLimit
                  - override.skipChecklist
                  - override.bypassDuplicateKeyCheck
                  - override.unscopedRules
                  - other.write
              environments:
                type: array
                items:
                  type: string
            required:
              - action
              - environments
            additionalProperties: false
        summary:
          type: string
        url:
          type: string
        expiresAt:
          type: string
        response:
          anyOf:
            - type: object
              properties:
                status:
                  type: number
                body: {}
              required:
                - status
              additionalProperties: false
            - type: 'null'
        note:
          type:
            - string
            - 'null'
      required:
        - id
        - status
        - actions
        - summary
        - url
        - expiresAt
        - response
        - note
      additionalProperties: false
  responses:
    ConfirmationHeld:
      description: >-
        Held until a person confirms it in GrowthBook. Poll the Location until
        the confirmation completes.
      headers:
        Location:
          description: The confirmation to poll
          schema:
            type: string
        Retry-After:
          description: Seconds to wait before polling
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ConfirmationHeld'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as the Bearer token. See
        [Authentication](/api/introduction#authentication).
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Pass your API key as the username and leave the password blank. See
        [Authentication](/api/introduction#authentication).

````