Make a public dashboard link
const url = 'https://beta-api.plune.ai/v1/dashboard-links';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"label":"Sprint review","widgetIds":["6f1c2b3a-0000-4000-8000-0000000000b4"],"periodDays":90,"periodOpen":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
Example
{ "label": "Sprint review", "widgetIds": [ "6f1c2b3a-0000-4000-8000-0000000000b4" ], "periodDays": 90, "periodOpen": true}Responses
Section titled “ Responses ”The link, with its token - once
object
object
How many widgets the link froze.
A visitor may pick a shorter preset; false, the period is fixed.
null: kept until revoked.
When the widgets were frozen: the creation or the last update of the shared view.
Example
{ "link": { "periodDays": 7 }}Invalid body, date or password, or a widget that cannot be shared
object
Example generated
{ "error": "example"}No / invalid token or session
Not the project’s owner
object
Example generated
{ "error": "example"}Public sharing is off, or the project has 20 active links
object
Example generated
{ "error": "example"}Body over 16 KiB
object
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.
object
Example generated
{ "error": "example"}Headers
Section titled “Headers ”Seconds until the window rolls over