List a dashboard's public links.

GET

/dashboards/{id}/shares

const url = 'https://api.siteqwality.com/dashboards/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shares';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://api.siteqwality.com/dashboards/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/shares \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

required

string format: uuid

Dashboard id

Responses

200

Every link, newest first

application/json

Array<object>

object

required

string format: uuid

url_token

required

The capability in https://app.siteqwality.com/share/d/<token>.

string

config

required

object

allowed_times

Presets a viewer may pick, from 15m 1h 4h 1d 2d 7d 30d 90d.

Array<string>

default_time

One of allowed_times.

string

theme

string

Allowed values: light dark auto

variables

object

key

additional properties

How a public viewer may use one variable. A variable the share does not list is locked to the dashboard default.

object

locked

boolean

allowed

The values a viewer may pick; null allows every value (and All when the variable includes it).

array | null

paused

required

boolean

expires_at

string | null format: date-time

created_by

One of:

null
object

null

created_at

required

string format: date-time

last_accessed_at

string | null format: date-time

access_count

required

integer format: int64

Example

[
  {
    "config": {
      "theme": "light"
    }
  }
]

401

Missing or invalid authentication

403

The caller cannot edit dashboards, or is a connected app

404

No such dashboard

500

Internal server error