compileWidgetPreview

POST

/api/v1/widgets/compile-preview

curl --request POST \
  --url https://example.com/api/v1/widgets/compile-preview \
  --header 'Content-Type: application/json' \
  --data '{ "provider": "example", "configuration": {} }'

Compile widget preview. Requires an authenticated dashboard user. Definitions without a player fallback answer a null data body.

Request Body^required

Media typeapplication/json

object

provider

required

Closed renderable Widget or App identifier from the release-owned content-definition catalog.

string

/^[a-z][a-z0-9_-]{0,79}$/

configuration

required

object

key

additional properties

any

Example^generated

{
  "provider": "example",
  "configuration": {}
}

Responses

200

Declarative presentation schema v1 document

Media typeapplication/json

object

data

required

Any of:

object

object

schemaVersion

required

integer

>= 1

kind

required

string

Allowed values: native web component

requiredCapabilities

required

object

key

additional properties

integer

>= 1

native

object

root

required

object

id

string

type

required

string

props

Renderer-specific node properties.

object

key

additional properties

any

binding

object

source

required

string

Allowed values: literal dataset repeat repeat_index environment

dataset

string

path

string

selector

string

startField

string

endField

string

value

string

fields

Array<string>

format

string

precision

integer

prefix

string

suffix

string

fallback

string

separator

string

repeat

object

dataset

required

string

limit

required

integer

selector

string

startField

string

endField

string

offset

integer

condition

object

binding

required

object

source

required

string

Allowed values: literal dataset repeat repeat_index environment

dataset

string

path

string

selector

string

startField

string

endField

string

value

string

fields

Array<string>

format

string

precision

integer

prefix

string

suffix

string

fallback

string

separator

string

op

required

string

Allowed values: equals not_equals empty not_empty greater_than greater_or_equal less_than less_or_equal before after

value

string

children

Array<object> recursive

web

object

mode

required

string

url

string

bundleId

string

entryPoint

string

integritySha256

string

packageSize

integer format: int64

downloadPath

string

allowedHosts

required

Array<string>

externalNetworkAccess

required

boolean

onlineOnly

required

boolean

fallbackBehavior

required

string

loadTimeoutSeconds

required

integer

lifecycle

required

string

warmSeconds

required

integer

reload

object

mode

required

string

intervalSeconds

required

integer

component

Set for kind component (docs/widgets-v2.md).

object

type

required

string

version

required

integer

>= 1

config

required

object

key

additional properties

any

dataSources

required

Array<string>

media

required

Array<object>

object

assetId

required

string

variantId

required

string

null

null

Example

{
  "data": {
    "kind": "native",
    "native": {
      "root": {
        "binding": {
          "source": "literal"
        },
        "condition": {
          "binding": {
            "source": "literal"
          },
          "op": "equals"
        }
      }
    }
  }
}

400

Draft configuration cannot be compiled