Skip to content

Make a public dashboard link

POST
/v1/dashboard-links
curl --request POST \
--url https://beta-api.plune.ai/v1/dashboard-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "label": "Sprint review", "widgetIds": [ "6f1c2b3a-0000-4000-8000-0000000000b4" ], "periodDays": 90, "periodOpen": true }'

Freezes the chosen widgets (ADR 0061 §3): their titles and recipes as they are now; their numbers stay live. periodDays 7, 30 or 90 is the longest period a visitor may pick, and with periodOpen false the period is fixed to it. expiresAt: absent is 7 days, null none, a date from an hour to 30 days. An optional password (8 to 128 printable ASCII characters). The token is in this 201 and nowhere else, ever. A widget whose recipe the catalogue outgrew (widget_stale) or that names suites by id (widget_suite) cannot be shared. 409 sharing_off while the switch is off, 409 link_limit at 20 active links. Owner only.

Media type application/json
object
label
string
>= 1 characters <= 120 characters
widgetIds
required
Array<string>
>= 1 items <= 30 items
periodDays
required
integer
Allowed values: 7 30 90
periodOpen
required
boolean
expiresAt
string | null format: date-time
password
string
>= 8 characters <= 128 characters
Example
{
"label": "Sprint review",
"widgetIds": [
"6f1c2b3a-0000-4000-8000-0000000000b4"
],
"periodDays": 90,
"periodOpen": true
}

The link, with its token - once

Media type application/json
object
link
required
object
id
required
string
label
required
string | null
widgets
required

How many widgets the link froze.

integer
periodDays
required
integer
Allowed values: 7 30 90
periodOpen
required

A visitor may pick a shorter preset; false, the period is fixed.

boolean
passwordProtected
required
boolean
expiresAt
required

null: kept until revoked.

string | null format: date-time
createdAt
required
string format: date-time
createdBy
required
string | null
sharedAt
required

When the widgets were frozen: the creation or the last update of the shared view.

string format: date-time
views
required
integer
lastViewedAt
required
string | null format: date-time
token
required
string
path
required
string
url
required
string | null
Example
{
"link": {
"periodDays": 7
}
}

Invalid body, date or password, or a widget that cannot be shared

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

Not the project’s owner

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Public sharing is off, or the project has 20 active links

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Body over 16 KiB

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over