Skip to main content
GET
Get dashboard template

Authorizations

Authorization
string
header
required

Organization API key, generated in studio.sidenet.ai. Backend only — never in a browser.

Path Parameters

key
string
required
Example:

"performance"

Query Parameters

scope
enum<string>
default:effective

effective (default): what the organization gets — shared templates with its overrides applied, plus its own; org: its own rows only; shared: the platform's shared templates as published.

Available options:
effective,
org,
shared

Response

The template

key
string
Example:

"performance"

collection
string

The publisher's set (default for a template written with PUT).

Example:

"pms"

ord
integer

Position in the picker (ascending, then key).

title
string
Example:

"Hotel performance"

description
string | null
icon
string | null
Example:

"chart"

tags
string[]

Audience: offered on the networks whose tags share one of these (PATCH /v1/networks/{id}). Empty = every network.

when
object | null

Offered only when a read run in the caller's session yields at least min_options distinct values: the spec's own select filter filter (one with options_from: its source and value path), or a source tool named outright (tool, args, value: the field path of the value in a row). E.g. { "tool": "pms_list_property_options", "value": "id", "min_options": 2 } offers a portfolio page to a caller with several hotels only.

spec
object

What POST /v1/dashboards takes as spec. Listed only with include_spec=true.

enabled
boolean
hash
string
source
enum<string>

repo: published by CI; api: written with PUT / PATCH.

Available options:
repo,
api
source_ref
string | null

The commit a repo template was published from, or who wrote an api one.

origin
enum<string>

org: this organization's own; shared: the platform's, shared with every organization; override: this organization's row over a shared one (shown merged).

Available options:
org,
shared,
override
created_at
string<date-time>
updated_at
string<date-time>