Overview
Reference
- AlertEvents
- AlertGroups
- AlertUrgencies
- AlertSources
- Alerts
- Audits
- Authorizations
- CatalogEntities
- CatalogEntityProperties
- CatalogFields
- Catalogs
- Causes
- [DEPRECATED] CustomFieldOptions
- [DEPRECATED] CustomFields
- CustomForms
- DashboardPanels
- Dashboards
- Environments
- EscalationPolicies
- EscalationLevelsPolicies
- EscalationLevelsPath
- EscalationLevels
- EscalationPaths
- FormFieldOptions
- FormFieldPlacementConditions
- FormFieldPlacements
- FormFieldPositions
- FormFields
- FormSetConditions
- FormSets
- Functionalities
- WorkflowTasks
- [DEPRECATED] WorkflowCustomFieldSelections
- WorkflowFormFieldConditions
- WorkflowGroups
- WorkflowRuns
- Workflows
- Heartbeats
- IncidentActionItems
- [DEPRECATED] IncidentCustomFieldSelections
- IncidentEventFunctionalities
- IncidentEventServices
- IncidentEvents
- IncidentFeedbacks
- IncidentFormFieldSelections
- IncidentPermissionSetBooleans
- IncidentPermissionSetResources
- IncidentPermissionSets
- IncidentRetrospectives
- IncidentRetrospectiveSteps
- IncidentRoleTasks
- IncidentRoles
- IncidentStatusPageEvents
- IncidentSubStatuses
- IncidentTypes
- Incidents
- IpRanges
- LiveCallRouters
- OnCallRoles
- OnCallShadows
- OverrideShifts
- PlaybookTasks
- Playbooks
- RetrospectiveTemplates
- Pulses
- RetrospectiveConfigurations
- RetrospectiveProcessGroupSteps
- RetrospectiveProcessGroups
- RetrospectiveProcesses
- RetrospectiveSteps
- Roles
- ScheduleRotationActiveDays
- ScheduleRotationUsers
- ScheduleRotations
- Schedules
- Shifts
- Secrets
- Services
- Severities
- StatusPageTemplates
- StatusPages
- SubStatuses
- Teams
- UserNotificationRules
- Users
- WebhooksDeliveries
- WebhooksEndpoints
Dashboards
Retrieves a dashboard
Dashboards
Retrieves a dashboard
Retrieves a specific dashboard by id
GET
/
v1
/
dashboards
/
{id}
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards/%7Bid%7D?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": {
"id": "5812af00-af87-4ca0-a56a-ca6df321f839",
"type": "dashboards",
"attributes": {
"team_id": 90,
"user_id": 88,
"name": "Dashboard 10",
"description": null,
"slug": "dashboard-10",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#FCF2CF",
"icon": "📊",
"auto_refresh": false,
"updated_at": "2025-03-11T19:09:17.471-07:00",
"created_at": "2025-03-11T19:09:17.471-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
comma separated if needed. eg: panels
Available options:
panels
Response
200
application/vnd.api+json
dashboard found
Unique ID of the dashboard
Available options:
dashboards
The name of the dashboard
The owner type of the dashboard
Available options:
user
, team
Whether the dashboard is public
The dashboard team
The dashboard user owner if owner is of type user
The description of the dashboard
The date range for dashboard panel data
The grouping period for dashboard panel data
Whether the dashboard auto-updates the UI with new data.
The hex color of the dashboard
Available options:
#FCF2CF
, #D7F5E1
, #E9E2FF
, #FAE6E8
, #FAEEE6
The emoji icon of the dashboard
Date of creation
Date of last update
Was this page helpful?
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards/%7Bid%7D?include=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": {
"id": "5812af00-af87-4ca0-a56a-ca6df321f839",
"type": "dashboards",
"attributes": {
"team_id": 90,
"user_id": 88,
"name": "Dashboard 10",
"description": null,
"slug": "dashboard-10",
"public": false,
"owner": "team",
"range": "Last 30 Days",
"period": "day",
"color": "#FCF2CF",
"icon": "📊",
"auto_refresh": false,
"updated_at": "2025-03-11T19:09:17.471-07:00",
"created_at": "2025-03-11T19:09:17.471-07:00"
},
"relationships": {
"panels": {
"data": []
}
}
}
}