Skip to main content
POST
Python (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json

PreviewConfigDashboard renders a config-managed dashboard from a patch ref before merge (ADR-0022). The previewing member + org come from auth context.

patchRef
string

git ref of the patch to preview from

dashboardPath
string

Library path of the .dashboard file

Response

Success

url
string

serving URL for the ephemeral preview

embedUrl
string

embeddable URL for the preview