πŸ“—
UpGrade Platform - Documentation
6.1
6.1
  • UpGrade Overview
  • Creating an Experiment
    • Unit of Assignment
    • Simple Experiment
    • Factorial Experiment
    • Inclusion and Exclusion
    • Schedule and Post-Rule
    • Exporting Experiment Data and Design
  • Creating a Feature Flag
  • How UpGrade Works
  • Researcher Guide
    • Working with segments
  • Developer Guide
    • ⚑Quick Start: Running UpGrade Locally with Docker
    • ⚑Quick Start: Running locally w/o Docker (on MacOS or Linux)
    • UpGrade + AdapComp (Mooclet) in Docker
    • πŸšΆβ€β™€οΈWalkthroughs
      • Your Application and UpGrade
      • Example 1: A Quiz Web App
      • Example 2: An Online Math Game
    • πŸ“šReference
      • API
      • Client Libraries
        • TypeScript / JS
          • Class: UpgradeClient
          • Class: Assignment
          • SDK Interfaces
            • Interface: IMetric
            • Interface: IExperimentUser
            • Interface: IExperimentUserAliases
            • Interface: ILog
            • Interface: IMarkExperimentPoint
            • Interface: IMetric
            • Interface: IRequestOptions
            • Interface: IResponse
            • Interface: IUser
            • Interface: IUserGroup
      • Environment Variables
        • Frontend Environment
        • Backend Environment
      • Context Metadata
      • Metrics
      • Setting up Google-Auth
      • API Authorization
      • Data Architecture
    • πŸ‘¨β€πŸ’»Contributing Code
      • Branching Workflow (Git-Flow)
      • Pull Request Expectations
    • πŸ˜…Troubleshooting
      • Relation β€˜experiment_condition’ already exists
      • User not found. Authorization error
      • Token is not present in the request header
      • nodemon exits without explanation
      • Unable to find New Relic module configuration
      • No email received for export data
      • Opening a new tab in UpGrade prompts for re-authorization
      • Error: Cannot find module 'upgrade_types' (or a type from 'upgrade_types' does not exist)
  • Glossary
Powered by GitBook
On this page
  • Overview
  • Create a segment
  • Add lists
  • Using Segments
  1. Researcher Guide

Working with segments

PreviousResearcher GuideNextDeveloper Guide

Last updated 3 days ago

Overview

Segments are a way to create reusable lists of users and group for inclusion or exclusion in experiments and feature flags. A segment consists of one or more lists which can each be of one of three types:

  • individual - a list of user ids

  • group - a list of group ids (for a specific group type)

  • segment - another already-defined segment

Create a segment

To create a new segment click on the 'Add Segment' button. You'll supply a name, an optional description, an app context from available contexts, and optional tags. These values can be edited later.

When you hit 'Create' a new segment will be created, with an empty 'Lists' list.

Add lists

When you click 'Add List' you'll need to choose the list type.

For type 'Segment', you'll choose one from a list of available segments that have already been created in your segment's context. Adding a list of type 'Segment' will include all the users and groups (and segments) in the selected segment's lists.

For type 'individual' or any of the 'Group:...' types, you'll add the ids to be included in the 'values' field - either by typing them in individually or uploading a csv file.

This lists now appear on the segment's page, from which you can edit/view/delete them. You can also import and export lists (json format),

and perform similar actions for the entire segment.

Using Segments

When a segment is used in any experiments or feature flags, those usages will show up in the 'Used By' tab of the segment's page.

To use a segment for inclusion in, or exclusion from, a feature flag or experiment, see the instructions for adding inclusions and exclusions of type 'segment' in or .

Creating an Experiment
Creating a Feature Flag