Class ExperimentsExperimentV2ListDTODataAttributes

Summary fields for an experiment returned in a list.

Hierarchy

  • ExperimentsExperimentV2ListDTODataAttributes

Constructors

constructor

Properties

additionalProperties? assignmentsEndDate? assignmentsStartDate? concludedAt? conclusion? createdAt? eventsEndDate? eventsStartDate? experimentType? hypothesis? migrationMetadata? name? pipelineTableSuffix? protocolId? relatedLinks? resultsLastUpdated? status? structuredMetadata? subjectTypeId? summary? tags? teams? updatedAt?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional assignmentsEndDate

assignmentsEndDate?: Date

End of the window used to read experiment assignments.

Optional assignmentsStartDate

assignmentsStartDate?: Date

Start of the window used to read experiment assignments.

Optional concludedAt

concludedAt?: Date

Time when the experiment was concluded.

Optional conclusion

conclusion?: ExperimentsPatchExperimentV2ResponseDataAttributesConclusion

Outcome and supporting text recorded when the experiment is concluded.

Optional createdAt

createdAt?: Date

Time when the experiment was created.

Optional eventsEndDate

eventsEndDate?: Date

End of the window used to read metric events.

Optional eventsStartDate

eventsStartDate?: Date

Start of the window used to read metric events.

Optional experimentType

experimentType?: string

Kind of experiment. STANDARD is an ordinary experiment. Other values, such as CANARY and HOLDOUT, identify experiments owned by another workflow. New kinds may be added; treat unknown values as non-standard.

Optional hypothesis

hypothesis?: string

Expected effect that the experiment is designed to test.

Optional migrationMetadata

migrationMetadata?: any

Metadata associated with migration of this resource.

Optional name

name?: string

Display name of the experiment.

Optional pipelineTableSuffix

pipelineTableSuffix?: string

Suffix used for the experiment tables in the analysis pipeline.

Optional protocolId

protocolId?: string

Identifier of the protocol associated with the experiment.

Optional relatedLinks

relatedLinks?: ExperimentsCreateExperimentV2RequestDataAttributesRelatedLinksItems[]

External links associated with the experiment.

Optional resultsLastUpdated

resultsLastUpdated?: Date

Time when the experiment results were last updated.

Optional status

status?: ExperimentsExperimentV2DTODataAttributesStatus

Current stage in the experiment lifecycle.

Optional structuredMetadata

structuredMetadata?: ExperimentsStructuredMetadataResponse[]

Custom metadata fields and their values for the experiment.

Optional subjectTypeId

subjectTypeId?: string

Identifier of the subject type used for experiment assignments.

Optional summary

summary?: string

Free-form summary of the experiment.

Optional tags

tags?: string[]

Tag names associated with the experiment.

Optional teams

teams?: string[]

Team handles associated with the experiment.

Optional updatedAt

updatedAt?: Date

Time when the experiment was last updated.

Settings

Member Visibility

Theme

Generated using TypeDoc