API Reference

Get a dashboard

View Markdown

GET /api/dashboards/{id}

Get a dashboard

Operation IDgetDashboard

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Dashboard with parsed widget definition

Dashboard with parsed widget definition

Content typeapplication/json

responseobject

10 properties

idinteger

job_idinteger

dashboard_template_idinteger | null

Nullable: yes

namestring

descriptionstring | null

Nullable: yes

statusstring

has_share_linkboolean

created_atstring · date-time

updated_atstring | null · date-time

Nullable: yes

dashboardobject

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

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

Code examples

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

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);