Skip to main content

​
Overview

Public dashboards provide a way to share monitoring status with stakeholders, customers, or team members without requiring access to your Checkly account. This endpoint returns all public dashboards configured in your account.

​
Response Example

{
  "data": [
    {
      "id": "dash_123456789",
      "name": "Production Services Status",
      "description": "Live status of all production services",
      "isPrivate": false,
      "customDomain": "status.example.com",
      "customUrl": "production-status",
      "tags": ["api", "frontend", "public", "status"],
      "checkIds": [
        "check_api_health",
        "check_website_uptime",
        "check_database_connection"
      ],
      "checkGroupIds": [
        "group_production_services",
        "group_critical_apis"
      ],
      "configuration": {
        "theme": "light",
        "logo": "https://example.com/logo.png",
        "refreshInterval": 30,
        "showCheckResults": true,
        "showIncidents": true,
        "customCSS": ".dashboard { font-family: 'Inter'; }"
      },
      "widgets": [
        {
          "type": "status_overview",
          "position": 1,
          "title": "System Status",
          "settings": {
            "showPercentage": true,
            "timeRange": "24h"
          }
        },
        {
          "type": "check_list",
          "position": 2,
          "title": "Service Health",
          "settings": {
            "groupByType": true,
            "showLastResult": true
          }
        }
      ],
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-20T14:45:00.000Z"
    },
    {
      "id": "dash_987654321",
      "name": "Team Engineering Dashboard",
      "description": "Internal monitoring dashboard for engineering team",
      "isPrivate": true,
      "customDomain": null,
      "customUrl": "engineering-internal",
      "tags": ["team", "internal", "engineering"],
      "checkIds": [
        "check_dev_api",
        "check_staging_frontend",
        "check_test_db"
      ],
      "checkGroupIds": [
        "group_development_services"
      ],
      "configuration": {
        "theme": "dark",
        "logo": null,
        "refreshInterval": 15,
        "showCheckResults": true,
        "showIncidents": false,
        "customCSS": null
      },
      "widgets": [
        {
          "type": "metrics_chart",
          "position": 1,
          "title": "Response Times",
          "settings": {
            "metric": "response_time",
            "timeRange": "7d"
          }
        }
      ],
      "createdAt": "2024-01-10T08:15:00.000Z",
      "updatedAt": "2024-01-18T16:20:00.000Z"
    }
  ],
  "meta": {
    "currentPage": 1,
    "totalPages": 1,
    "totalItems": 2,
    "limit": 10
  }
}

​
Common Use Cases

Status Pages

Share service status with customers and stakeholders
GET /v1/dashboards?tags=public,status

Team Dashboards

Provide team-specific monitoring views for different teams
GET /v1/dashboards?tags=team,internal

Executive Reports

High-level overview dashboards for management reporting
GET /v1/dashboards?tags=executive,summary

Customer Communication

Transparent communication during incidents and maintenance
GET /v1/dashboards?isPrivate=false

​
Additional Examples

curl -X GET "https://api.checklyhq.com/v1/dashboards?isPrivate=false" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"
Public dashboards can be accessed without authentication using their custom URLs or domains. Private dashboards require appropriate account access.