A public dashboard - no account
const url = 'https://beta-api.plune.ai/public/dashboard/example?days=7';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://beta-api.plune.ai/public/dashboard/example?days=7'What anyone who holds the address sees of a project’s shared widgets (#1266, ADR 0061), with no credential and no cookie: the project’s name, when the widgets were frozen, and per widget its title, its recipe and its numbers now (series, group labels, denominators) - or the code of why there are none (config_stale, widget_too_expensive, too_many_points). No id of anything, no case or run names, no people, no error text, no files. watermark is always there. days picks the period, 7, 30 or 90 up to what the owner allowed; a link whose period is fixed ignores it, and every other parameter is ignored (ADR 0061 §5). Unknown, revoked, malformed and a project whose public sharing is off are ONE answer, the same 404. After its end a link answers 410 expired. A password goes in the X-Dashboard-Password header: none sent is 401 password_required, a wrong one 401 wrong_password; 10 wrong in 15 minutes per token, 30 password-bearing requests a minute per client, then 429. Each answered visit is counted on the link, never audited. Sent with Cache-Control: private, no-store, X-Robots-Tag: noindex, nofollow and Referrer-Policy: no-referrer. 120 a minute for a client address.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”43 characters of base64url.
Query Parameters
Section titled “Query Parameters ”7, 30 or 90, up to what the owner allowed.
The visitor’s time zone for the buckets, like Europe/Kyiv.
Header Parameters
Section titled “Header Parameters ”The link’s password, when it has one.
Responses
Section titled “ Responses ”The dashboard
object
object
object
The whole recipe of a widget; the server judges it on every write and every draft. Entities: case, run_result, run, requirement (a defect is not one yet). Properties come from a closed catalogue: a case has type, state, priority, suite, is_flaky, is_muted, tag; a result status, sub_status, source, muted, case_priority, environment, label; a run kind, environment, status_event, label; a requirement type, status, priority, category. A donut takes one block. A segment is cut across all blocks and only by a property they all have (label for runs and results; any groupable property for a single entity). Limits: 5 blocks, 10 segment values, 10 filters a block, 16 KiB.
object
Line only: the population at each moment. For run_result and run (they only arrive); a case, a requirement and a defect wait.
object
A duration only for run_result and run.
object
A groupable property of the entity. More than 20 groups: the rest is folded into «Other» with a true sum.
object
The numbers of a widget. Every block shares one time axis; every block carries its denominator.
object
The start of each bucket, as a calendar date in the reader’s zone; at most 366.
At most 50 (blocks x groups x segment values), the biggest first when cut; empty for a table.
object
null: no value of the grouped property, or no Group by.
Over the whole period: what a donut slice or a table row shows.
object
A table’s rows, at most 500.
object
A6: per block, how many objects of the entity the project has in the period BEFORE the filters (denominator) and after them (matched). null for a block that ran out of time.
object
Series or rows were dropped to hold the caps.
What could not be measured or shown whole, as codes: truncated_series, truncated_rows, folded_groups, block_timeout.
object
object
Example
{ "days": 7, "periodDays": 7, "widgets": [ { "config": { "schemaVersion": 1, "render": "bar", "bucket": "day", "accumulated": false, "blocks": [ { "entity": "case", "metric": "count" } ] }, "data": { "render": "bar", "bucket": "day", "series": [ { "entity": "case" } ], "notMeasured": [ { "code": "truncated_series" } ] } } ], "watermark": "Made with Plune"}A password is set and none or a wrong one was sent
object
Example generated
{ "error": "example"}No such link, revoked, or public sharing is off
object
Example generated
{ "error": "example"}The link has expired
object
Example generated
{ "error": "example"}Too many requests from this client address, or too many wrong passwords for this link.