Get a dashboard

GET /api/dashboards/{id}

Get a dashboard

Operation ID: getDashboard

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Path parameters

• id — integer, required Resource ID

Success responses

200

Dashboard with parsed widget definition

Content type: application/json

• Type: Dashboard & object
• All of:
  • Variant 1:
    • Reference: Dashboard
      • Type: object
      • Properties:
        • id (integer)
        • job_id (integer)
        • dashboard_template_id (integer | null)
          • Nullable: yes
        • name (string)
        • description (string | null)
          • Nullable: yes
        • status (string)
        • has_share_link (boolean)
        • created_at (string)
          • Format: date-time
        • updated_at (string | null)
          • Format: date-time
          • Nullable: yes
  • Variant 2:
    • Type: object
    • Properties:
      • dashboard (object)

Error responses

404

Resource not found

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Examples

cURL

curl --request GET \
  --url 'https://your-envoy.example.com/api/dashboards/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY'

JavaScript (fetch)

const response = await fetch('https://your-envoy.example.com/api/dashboards/YOUR_ID', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  },
});
 
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);