Skip to main content
POST
/
v1
/
surfaces
Create Surface
curl --request POST \
  --url https://workflow.eu.confidence.dev/v1/surfaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "<string>",
  "name": "<string>",
  "description": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "reviews": {
    "mandatory": true,
    "reviewers": [
      "<string>"
    ]
  },
  "metricConfig": {
    "mandatoryMetrics": [
      {
        "metric": "<string>",
        "preferredDirection": "PREFERRED_DIRECTION_UNSPECIFIED",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "associatedMetrics": [
      {
        "metric": "<string>"
      }
    ]
  },
  "automatedActions": [
    {
      "trigger": {
        "activityTrigger": {
          "kind": "<string>",
          "resource": "<string>"
        },
        "stateTrigger": {
          "state": "<string>",
          "resource": "<string>"
        }
      },
      "action": {
        "executeFunctionAction": {
          "function": "<string>",
          "parameters": {}
        },
        "pagerdutyAction": {
          "pdKey": "<string>",
          "severity": "critical",
          "title": "<string>",
          "description": "<string>"
        },
        "transitionAction": {
          "action": "<string>",
          "parameters": {}
        }
      }
    }
  ],
  "stakeholders": [
    {
      "identity": "<string>",
      "role": "<string>"
    }
  ]
}
'
{
  "displayName": "<string>",
  "createTime": {},
  "updateTime": {},
  "deleteTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "description": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>",
  "reviews": {
    "mandatory": true,
    "reviewers": [
      "<string>"
    ]
  },
  "metricConfig": {
    "mandatoryMetrics": [
      {
        "metric": "<string>",
        "preferredDirection": "PREFERRED_DIRECTION_UNSPECIFIED",
        "successMetric": {
          "minimumDetectableEffect": {
            "value": "<string>"
          }
        },
        "guardrailMetric": {
          "nonInferiorityMargin": {
            "value": "<string>"
          }
        }
      }
    ],
    "associatedMetrics": [
      {
        "metric": "<string>"
      }
    ]
  },
  "automatedActions": [
    {
      "trigger": {
        "activityTrigger": {
          "kind": "<string>",
          "resource": "<string>"
        },
        "stateTrigger": {
          "state": "<string>",
          "resource": "<string>"
        }
      },
      "action": {
        "executeFunctionAction": {
          "function": "<string>",
          "parameters": {}
        },
        "pagerdutyAction": {
          "pdKey": "<string>",
          "severity": "critical",
          "title": "<string>",
          "description": "<string>"
        },
        "transitionAction": {
          "action": "<string>",
          "parameters": {}
        }
      }
    }
  ],
  "stakeholders": [
    {
      "identity": "<string>",
      "role": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
surfaceId
string

The id to use for the surface. If not set, a random id will be generated.

Body

application/json
​
displayName
string
required

A human-readable name for the 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.

​
owner
string

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

​
reviews
object

Surface config for experiment reviews.

​
metricConfig
object

Configuration for metrics the surface.

​
automatedActions
object[]

Actions to trigger once the metric starts tanking

​
stakeholders
object[]

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

Response

200 - application/json

Returns a Surface.

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.

​
deleteTime
object
required

If set, time when the surface was deleted.

​
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.

​
owner
string

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

​
reviews
object

Surface config for experiment reviews.

​
metricConfig
object

Configuration for metrics the surface.

​
automatedActions
object[]

Actions to trigger once the metric starts tanking

​
stakeholders
object[]

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