Create an expiring private dashboard URL

Create an expiring, private-by-possession hosted dashboard URL for an analysis and selected design system.

POST /dashboard-links

Create an expiring private dashboard URL

cURL

curl --request POST \
  --url https://api.foreverbetter.xyz/dashboard-links \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "analysis_id": "<string>",
  "design_id": "<string>",
  "expires_in_days": 30
}
'

import requests

url = "https://api.foreverbetter.xyz/dashboard-links"

payload = {
    "analysis_id": "<string>",
    "design_id": "<string>",
    "expires_in_days": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({analysis_id: '<string>', design_id: '<string>', expires_in_days: 30})
};

fetch('https://api.foreverbetter.xyz/dashboard-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.foreverbetter.xyz/dashboard-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'analysis_id' => '<string>',
    'design_id' => '<string>',
    'expires_in_days' => 30
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.foreverbetter.xyz/dashboard-links"

	payload := strings.NewReader("{\n  \"analysis_id\": \"<string>\",\n  \"design_id\": \"<string>\",\n  \"expires_in_days\": 30\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.foreverbetter.xyz/dashboard-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysis_id\": \"<string>\",\n  \"design_id\": \"<string>\",\n  \"expires_in_days\": 30\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.foreverbetter.xyz/dashboard-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysis_id\": \"<string>\",\n  \"design_id\": \"<string>\",\n  \"expires_in_days\": 30\n}"

response = http.request(request)
puts response.read_body

201

{
  "dashboard_url": "<string>",
  "analysis_id": "<string>",
  "design": {
    "id": "<string>",
    "name": "<string>",
    "layout": {}
  },
  "visibility": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "sharing": {
    "default": "<string>",
    "optional": true,
    "note": "<string>"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "request_id": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

analysis_id · string · required

Analysis whose dashboard snapshot will be rendered.

design_id · string · required

A design ID from GET /design/systems.

expires_in_days · integer · default: 30

Required range: 1 <= x <= 90

Response

201

application/json

Created

dashboard_url · string<uri> · required

Bearer URL for the exact dashboard snapshot. Keep it private unless the user chooses to share it.

analysis_id · string · required

design · object · required

Show child attributes

visibility · string · required

Allowed value: "private_by_possession"

expires_at · string<date-time> · required

sharing · object · required

Show child attributes