Dimensions
Resource views for use in reporting.
Winning Variant will maintain a view for each resource type (lab, experiment, subject type) as they are created/updated within the platform. These may be used for joins against the primary Assignments View to retrieve context for the assignments.
It’s important to know that each view shows only the current version/state of a resources.
Application Roles
A user must be mapped to one of the following application roles to access dimension views
admineditoranalyst
Views
Labs
View: <application_name>.experimentation.labs
Unique key: id
| Field | Description | Data Type |
|---|---|---|
id | Unique ID for the lab | varchar |
resource_version | Current resource version | int |
status | Current status | ResourceStatus |
name | Name of the lab | varchar |
description | Resource description | varchar |
Subject Types
View: <application_name>.experimentation.subject_types
Unique key: id
| Field | Description | Data Type |
|---|---|---|
id | Unique ID for the subject type | varchar |
resource_version | Current resource version | int |
status | Current status | ResourceStatus |
name | Name of the subject type | varchar |
description | Resource description | varchar |
match_type | The match type for the subject type. | MatchType |
Experiments
View: <application_name>.experimentation.experiments
Unique key: id
| Field | Description | Data Type |
|---|---|---|
id | Unique ID for the experiment | varchar |
resource_version | Current resource version | int |
status | Current status | ResourceStatus |
name | Name of the experiment | varchar |
description | Resource description | varchar |
parent_lab_id | ID of the lab the experiment belongs within. | varchar |
subject_type_id | ID of the subject type this experiment uses. | varchar |
hypothesis | The experiment hypothesis. | varchar |
active_cohort | Index for the active cohort. | int |
winning_variant | If specified, the ID of the winning variant. | varchar |
ended_reason | The reason the experiment was ended, if applicable. | EndedReason |
Experiment Variants
View: <application_name>.experimentation.experiment_variants
One row for each experiment-variant combo. Unique key: (experiment,id)
| Field | Description | Data Type |
|---|---|---|
experiment_id | ID of the experiment this variant belongs to. | varchar |
variant_id | ID of the variant. | varchar |
is_control | Whether this variant is the control within the experiment. | bool |
name | Variant name | varchar |
description | Variant description | varchar |
Experiment Cohort-Variants
View: <application_name>.experimentation.experiment_cohorts
One row for each experiment-cohort-variant combo. Unique key: (experiment_id,cohort_index,variant_id) .
Note that experiment variants may be listed redundantly since they can exist within multiple experiment cohorts. As such, all variant_id values in this table are within the context of the experiment to which they belong.
Within an experiment, the cohort with the highest cohort_index is the active one.
| Field | Description | Data Type |
|---|---|---|
experiment_id | ID of the experiment this cohort-variant belongs to. | varchar |
cohort_index | Unique integer assigned to the cohort within its experiment. | int |
variant_id | ID of the variant (within its experiment) | varchar |
split | Percentage of traffic that should see the variant (within the cohort). E.g., 0.500 | number(5,4) |
created_at | Timestamp of when the cohort was created | timestamp |
Examples
List all active experiments