Update a dashboard

curl --request PATCH \
  --url https://api.select.dev/v2/dashboards/{dashboard_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "team_id": "<string>",
  "layout": {},
  "filters": [
    "<unknown>"
  ],
  "date_range": {
    "relative_shortcut": "<string>",
    "start_date": "<string>",
    "end_date": "<string>"
  },
  "freeform_layout": [
    {
      "x": 1,
      "y": 1,
      "w": 11,
      "h": 123,
      "i": "<string>"
    }
  ],
  "icon": "<string>",
  "color": "<string>"
}
'

import requests

url = "https://api.select.dev/v2/dashboards/{dashboard_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "team_id": "<string>",
    "layout": {},
    "filters": ["<unknown>"],
    "date_range": {
        "relative_shortcut": "<string>",
        "start_date": "<string>",
        "end_date": "<string>"
    },
    "freeform_layout": [
        {
            "x": 1,
            "y": 1,
            "w": 11,
            "h": 123,
            "i": "<string>"
        }
    ],
    "icon": "<string>",
    "color": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    team_id: '<string>',
    layout: {},
    filters: ['<unknown>'],
    date_range: {relative_shortcut: '<string>', start_date: '<string>', end_date: '<string>'},
    freeform_layout: [{x: 1, y: 1, w: 11, h: 123, i: '<string>'}],
    icon: '<string>',
    color: '<string>'
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}', 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.select.dev/v2/dashboards/{dashboard_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'team_id' => '<string>',
    'layout' => [
        
    ],
    'filters' => [
        '<unknown>'
    ],
    'date_range' => [
        'relative_shortcut' => '<string>',
        'start_date' => '<string>',
        'end_date' => '<string>'
    ],
    'freeform_layout' => [
        [
                'x' => 1,
                'y' => 1,
                'w' => 11,
                'h' => 123,
                'i' => '<string>'
        ]
    ],
    'icon' => '<string>',
    'color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.select.dev/v2/dashboards/{dashboard_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}")

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.patch("https://api.select.dev/v2/dashboards/{dashboard_id}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/dashboards/{dashboard_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "visibility": "private",
  "status": "draft",
  "created_by": "<string>",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "description": "<string>",
  "team_id": "<string>",
  "updated_by": "<string>",
  "layout": {},
  "filters": [
    "<unknown>"
  ],
  "date_range": {
    "relative_shortcut": "<string>",
    "start_date": "<string>",
    "end_date": "<string>"
  },
  "time_grain": "day",
  "freeform_layout": [
    {
      "x": 1,
      "y": 1,
      "w": 11,
      "h": 123,
      "i": "<string>"
    }
  ],
  "icon": "<string>",
  "color": "<string>",
  "blocks": [
    {
      "id": "<string>",
      "config": {
        "query_class": "<string>",
        "title": "<string>",
        "block_type": "big_number",
        "display": {
          "metric": "<string>",
          "previous_period_comparison": "none",
          "comparison_period": "previous_period"
        },
        "description": "",
        "tooltip": "",
        "query_scope": {
          "filters": [],
          "overrides_dashboard_date_range": false,
          "overrides_dashboard_time_grain": false,
          "hide_incomplete_periods": false
        }
      },
      "create_time": "<string>",
      "update_time": "<string>",
      "etag": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

PATCH

dashboards

{dashboard_id}

Update a dashboard

curl --request PATCH \
  --url https://api.select.dev/v2/dashboards/{dashboard_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "team_id": "<string>",
  "layout": {},
  "filters": [
    "<unknown>"
  ],
  "date_range": {
    "relative_shortcut": "<string>",
    "start_date": "<string>",
    "end_date": "<string>"
  },
  "freeform_layout": [
    {
      "x": 1,
      "y": 1,
      "w": 11,
      "h": 123,
      "i": "<string>"
    }
  ],
  "icon": "<string>",
  "color": "<string>"
}
'

import requests

url = "https://api.select.dev/v2/dashboards/{dashboard_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "team_id": "<string>",
    "layout": {},
    "filters": ["<unknown>"],
    "date_range": {
        "relative_shortcut": "<string>",
        "start_date": "<string>",
        "end_date": "<string>"
    },
    "freeform_layout": [
        {
            "x": 1,
            "y": 1,
            "w": 11,
            "h": 123,
            "i": "<string>"
        }
    ],
    "icon": "<string>",
    "color": "<string>"
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    team_id: '<string>',
    layout: {},
    filters: ['<unknown>'],
    date_range: {relative_shortcut: '<string>', start_date: '<string>', end_date: '<string>'},
    freeform_layout: [{x: 1, y: 1, w: 11, h: 123, i: '<string>'}],
    icon: '<string>',
    color: '<string>'
  })
};

fetch('https://api.select.dev/v2/dashboards/{dashboard_id}', 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.select.dev/v2/dashboards/{dashboard_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'team_id' => '<string>',
    'layout' => [
        
    ],
    'filters' => [
        '<unknown>'
    ],
    'date_range' => [
        'relative_shortcut' => '<string>',
        'start_date' => '<string>',
        'end_date' => '<string>'
    ],
    'freeform_layout' => [
        [
                'x' => 1,
                'y' => 1,
                'w' => 11,
                'h' => 123,
                'i' => '<string>'
        ]
    ],
    'icon' => '<string>',
    'color' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$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.select.dev/v2/dashboards/{dashboard_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}")

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

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	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.patch("https://api.select.dev/v2/dashboards/{dashboard_id}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/dashboards/{dashboard_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"team_id\": \"<string>\",\n  \"layout\": {},\n  \"filters\": [\n    \"<unknown>\"\n  ],\n  \"date_range\": {\n    \"relative_shortcut\": \"<string>\",\n    \"start_date\": \"<string>\",\n    \"end_date\": \"<string>\"\n  },\n  \"freeform_layout\": [\n    {\n      \"x\": 1,\n      \"y\": 1,\n      \"w\": 11,\n      \"h\": 123,\n      \"i\": \"<string>\"\n    }\n  ],\n  \"icon\": \"<string>\",\n  \"color\": \"<string>\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "visibility": "private",
  "status": "draft",
  "created_by": "<string>",
  "create_time": "<string>",
  "update_time": "<string>",
  "etag": "<string>",
  "description": "<string>",
  "team_id": "<string>",
  "updated_by": "<string>",
  "layout": {},
  "filters": [
    "<unknown>"
  ],
  "date_range": {
    "relative_shortcut": "<string>",
    "start_date": "<string>",
    "end_date": "<string>"
  },
  "time_grain": "day",
  "freeform_layout": [
    {
      "x": 1,
      "y": 1,
      "w": 11,
      "h": 123,
      "i": "<string>"
    }
  ],
  "icon": "<string>",
  "color": "<string>",
  "blocks": [
    {
      "id": "<string>",
      "config": {
        "query_class": "<string>",
        "title": "<string>",
        "block_type": "big_number",
        "display": {
          "metric": "<string>",
          "previous_period_comparison": "none",
          "comparison_period": "previous_period"
        },
        "description": "",
        "tooltip": "",
        "query_scope": {
          "filters": [],
          "overrides_dashboard_date_range": false,
          "overrides_dashboard_time_grain": false,
          "hide_incomplete_periods": false
        }
      },
      "create_time": "<string>",
      "update_time": "<string>",
      "etag": "<string>"
    }
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "validation_failed",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Organization API key (sl_…).

Headers

If-Match

string | null

The dashboard's current ETag.

x-tenant-id

string

required

The organization ID the request is scoped to.

Path Parameters

dashboard_id

string

required

Body

application/json

Changes to apply to a dashboard.

Omitted fields remain unchanged. An explicit null clears a nullable field. Blocks are managed through the dashboard's block collection.

name

string

description

string | null

visibility

enum<string>

Available options:

private,

team,

public

status

enum<string>

Available options:

draft,

published

team_id

string | null

layout

Layout · object | null

filters

any[] | null

date_range

DateRange · object | null

Show child attributes

time_grain

enum<string> | null

Available options:

day,

week,

month

freeform_layout

FreeformLayoutItem · object[] | null

Show child attributes

icon

string | null

color

string | null

Response

Successful Response

A configurable collection of blocks for monitoring related information.

string

required

read-only

The unique identifier of the dashboard.

name

string

required

The display name of the dashboard.

visibility

enum<string>

required

Who can access the dashboard: its owner, a team, or the organization.

Available options:

private,

team,

public

status

enum<string>

required

Whether the dashboard is a draft or has been published.

Available options:

draft,

published

created_by

string

required

read-only

The identifier of the user or API key that created the dashboard.

create_time

string

required

read-only

When the dashboard was created, as an RFC 3339 UTC timestamp.

update_time

string

required

read-only

When the dashboard was last changed, as an RFC 3339 UTC timestamp.

etag

string

required

read-only

Opaque strong ETag. Supply it in an If-Match header when changing or deleting the dashboard.

description

string | null

Additional context about the dashboard and its purpose.

team_id

string | null

The team the dashboard is shared with. Set only when visibility is team.

updated_by

string | null

The identifier of the user or API key that most recently changed the dashboard.

layout

Layout · object | null

Saved layout settings for the dashboard.

filters

any[] | null

Filters applied to all compatible blocks in the dashboard.

date_range

DateRange · object | null

Date range applied to all compatible blocks in the dashboard.

Show child attributes

time_grain

enum<string> | null

Time grain applied to all compatible blocks in the dashboard.

Available options:

day,

week,

month

freeform_layout

FreeformLayoutItem · object[] | null

Positions and sizes of blocks on the dashboard grid.

Show child attributes

icon

string | null

Icon associated with the dashboard.

color

string | null

Color associated with the dashboard.

blocks

Block · object[]

Blocks contained in the dashboard, oldest first.

Show child attributes

Get Started

Endpoints

Update a dashboard

Authorizations

Headers

Path Parameters

Body

Response