GET
/
v1
/
dashboards
/
{dashboardId}
Retrieve a dashboard
curl --request GET \
  --url https://api.checklyhq.com/v1/dashboards/{dashboardId} \
  --header 'Authorization: <api-key>'
{
  "customDomain": "https://status.mycompany.com/",
  "customUrl": "status",
  "logo": "https://static.mycompany.com/static/images/logo.svg",
  "favicon": "https://static.mycompany.com/static/images/icon.svg",
  "link": "https://www.mycompany.com/",
  "description": "My dashboard description",
  "width": "FULL",
  "refreshRate": 60,
  "paginate": true,
  "paginationRate": 60,
  "checksPerPage": 15,
  "useTagsAndOperator": false,
  "hideTags": false,
  "enableIncidents": false,
  "expandChecks": false,
  "tags": [
    "production"
  ],
  "showHeader": true,
  "showCheckRunLinks": false,
  "customCSS": "",
  "isPrivate": false,
  "showP95": true,
  "showP99": true,
  "keys": [
    {
      "id": "<string>",
      "rawKey": "da_a89026d28a0c45cf9e11b4c3637f3912",
      "maskedKey": "...6a1e",
      "created_at": "2023-12-25",
      "updated_at": "2023-12-25"
    }
  ],
  "id": 123,
  "dashboardId": "1",
  "created_at": "2023-11-07T05:31:56Z",
  "header": "<string>"
}

​
Overview

The Get Dashboard endpoint retrieves comprehensive details about a specific dashboard, including its configuration, displayed checks, layout settings, and access permissions. Common Use Cases:
  • Dashboard Configuration Review
  • Settings Inspection
  • Access Control Verification
  • Dashboard Management
This endpoint returns complete dashboard configuration including check assignments, layout preferences, and sharing settings.

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here.

Your API key is like a password: keep it secure!

Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Path Parameters

​
dashboardId
string
required

Query Parameters

​
type
enum<string>
Available options:
customUrl,
customDomain

Response

Successful

​
id
number
required
​
dashboardId
string
required
Example:

"1"

​
created_at
string<date-time>
required
​
customDomain
string

A custom user domain, e.g. "status.example.com". See the docs on updating your DNS and SSL usage.

Example:

"https://status.mycompany.com/"

​
customUrl
string

A subdomain name under "checklyhq.com". Needs to be unique across all users.

Example:

"status"

A URL pointing to an image file.

Example:

"https://static.mycompany.com/static/images/logo.svg"

​
favicon
string

A URL pointing to an image file used as dashboard favicon.

Example:

"https://static.mycompany.com/static/images/icon.svg"

​
link
string

A URL link to redirect when dashboard logo is clicked on.

Example:

"https://www.mycompany.com/"

​
description
string

A piece of text displayed below the header or title of your dashboard.

Example:

"My dashboard description"

​
width
enum<string>
default:FULL

Determines whether to use the full screen or focus in the center.

Available options:
FULL,
960PX
​
refreshRate
enum<number>
default:60

How often to refresh the dashboard in seconds.

Available options:
60,
300,
600
​
paginate
boolean
default:true

Determines of pagination is on or off.

​
paginationRate
enum<number>
default:60

How often to trigger pagination in seconds.

Available options:
30,
60,
300
​
checksPerPage
number
default:15

Number of checks displayed per page.

Required range: 1 <= x <= 20
​
useTagsAndOperator
boolean
default:false

When to use AND operator for tags lookup.

​
hideTags
boolean
default:false

Show or hide the tags on the dashboard.

​
enableIncidents
boolean
default:false

Enable or disable incidents on the dashboard.

​
expandChecks
boolean
default:false

Expand or collapse checks on the dashboard.

​
tags
string[]

A list of one or more tags that filter which checks to display on the dashboard.

Example:
["production"]
​
showHeader
boolean
default:true

Show or hide header and description on the dashboard.

​
showCheckRunLinks
boolean
default:false

Show or hide check run links on the dashboard.

​
customCSS
string
default:""

Custom CSS to be applied to the dashboard.

​
isPrivate
boolean
default:false

Determines if the dashboard is public or private.

​
showP95
boolean
default:true

Show or hide the P95 stats on the dashboard.

​
showP99
boolean
default:true

Show or hide the P99 stats on the dashboard.

​
keys
object[]

Show key for private dashboard.

​
header
string