Skip to main content

AbTestVariant

Test variant returned within abTestList and detail queries, with optional metrics and tracking links.

type AbTestVariant {
  id: Int!
  editorPatch: String
  position: Int!
  redirectUrl: String
  resultsId: String!
  retiredAt: Int
  type: AbTestVariantType!
  variantName: String!
  isRetired: Boolean!
  snapshotId: Int
  viewVariantUrl: String
  thumbnailUrl: String
  screenshotUrl: String
  results: AbTestVariantResult
  permissions: AbTestVariantPermissions!
  createdAt: Int!
  updatedAt: Int!
  weight: Float
  significance: Float
  description: String
}

Fields

`AbTestVariant.id` ● `Int!` non-null scalar

`AbTestVariant.editorPatch` ● `String` scalar

JSON-encoded string in the editorPatch input format; null for controls, SPLIT variants, and variants without a patch.

`AbTestVariant.position` ● `Int!` non-null scalar

Zero-based stored variant position; creation assigns position 0 to control.

`AbTestVariant.redirectUrl` ● `String` scalar

Redirect destination for a split variant; null when not configured or not a redirect variant.

`AbTestVariant.resultsId` ● `String!` non-null scalar

Opaque results-tracking id used in preview links; variant mutations accept numeric id instead.

`AbTestVariant.retiredAt` ● `Int` scalar

Retirement time in Unix seconds; null while the variant is not retired.

`AbTestVariant.type` ● `AbTestVariantType!` non-null enum

Stored variant kind; a missing stored kind is reported as VARIANT.

`AbTestVariant.variantName` ● `String!` non-null scalar

Control for the control, otherwise Variant # and the position, for example Variant #2.

`AbTestVariant.isRetired` ● `Boolean!` non-null scalar

Whether a retirement timestamp is present.

`AbTestVariant.snapshotId` ● `Int` scalar

Id of this variant's snapshot; null unless the test was saved with createSnapshots and has been published.

`AbTestVariant.viewVariantUrl` ● `String` scalar

Test page URL with a variant preview fragment; null for a split variant with no redirect destination.

`AbTestVariant.thumbnailUrl` ● `String` scalar

Signed variant thumbnail URL; null if no variant id or asset path can be built.

`AbTestVariant.screenshotUrl` ● `String` scalar

Signed variant screenshot URL; null if no variant id or asset path can be built.

`AbTestVariant.results` ● `AbTestVariantResult` object

Computed metrics; null when metrics were not loaded, including editor and result detail queries.

`AbTestVariant.permissions` ● `AbTestVariantPermissions!` non-null object

Viewer-specific action flags based on test status, retirement, and available results or snapshots.

`AbTestVariant.createdAt` ● `Int!` non-null scalar

Creation time in Unix seconds.

`AbTestVariant.updatedAt` ● `Int!` non-null scalar

Last update time in Unix seconds.

`AbTestVariant.weight` ● `Float` scalar

Configured traffic percentage, stored to tenths of a percent; null when no manual weight is set.

`AbTestVariant.significance` ● `Float` scalar

Chi-square significance, 0-100 percent; null when metrics or a comparison are absent, or for PATCH kind.

`AbTestVariant.description` ● `String` scalar

Saved descriptive text; null when none has been saved.

Member Of

AbTest object

Fields
Member Of