Surface - Confidence Documentation

A surface that represents some area of an application that can be experimented on.

displayName

string

required

A human-readable name for the surface.

createTime

object

required

Time when the surface was first created.

updateTime

object

required

Time when the surface was last updated.

creator

string

required

Reference to the identity that created this surface.

updater

string

required

Reference to the identity that last updated this surface.

name

string

The identifier for the surface, for example, `surfaces/ndcrhu0tzbin85xzpszv.

description

string

A description for what the surface represents in the application.

labels

object[]

Custom labels for this surface.

Show child attributes

deleteTime

object

If set, time when the surface was deleted.

owner

string

The owner of the resource. If not set will default to the creator.

reviews

object

Surface config for experiment reviews.

Show child attributes

metricConfig

object

Configuration for metrics the surface.

Show child attributes

automatedActions

object[]

Actions to trigger once the metric starts tanking

Show child attributes

stakeholders

object[]

People with specific roles or responsibilities for the surface, such as product or engineering leads.

Show child attributes

{
  "displayName": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "description": "<string>",
  "labels": [
    {}
  ],
  "deleteTime": {},
  "owner": "<string>",
  "reviews": {
    "mandatory": true,
    "reviewers": [
      "<string>"
    ]
  },
  "metricConfig": {
    "mandatoryMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "associatedMetrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "metrics": [
      {
        "metric": "<string>",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ]
  },
  "automatedActions": [
    {
      "trigger": {
        "activityTrigger": {
          "kind": "<string>",
          "resource": "<string>"
        },
        "stateTrigger": {
          "state": "<string>",
          "resource": "<string>"
        }
      },
      "action": {
        "executeFunctionAction": {
          "function": "<string>",
          "parameters": {}
        },
        "transitionAction": {
          "action": "<string>",
          "parameters": {}
        }
      }
    }
  ],
  "stakeholders": [
    {
      "identity": "<string>",
      "role": "<string>"
    }
  ]
}

Documentation Index