The Experiments Object

The experiments response property is an array of running experiments. Each item describes an experiment, including its variants and per-variant story mappings.

Experiment item properties

• id required number

  Numeric ID of the experiment.

• name required string

  Internal name (lowercase letters, numbers, and underscores).

• display_name required string

  Human-readable display name.

• story_ids required number[]

  IDs of stories assigned to the experiment.

• variants required object[]

  Variants belonging to the experiment.

  Show child properties

  • name required string

    Internal name (lowercase letters, numbers, and underscores).

  • display_name required string

    Human-readable display name.

  • public_id required string

    Public identifier for stable bucketing.

  • weight required number

    Traffic weight percentage (0–100).

  • is_control required boolean

    true if the variant is the control.

  • story_mappings required object[]

    Mappings between original stories and their variant copies.

    Show child properties

    • original_story_id required number

      Numeric ID of the original story.

    • original_slug required string | null

      Slug of the original story.

    • variant_story_id required number | null

      Numeric ID of the variant story copy.

    • variant_slug required string | null

      Slug of the variant story copy.