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
DashboardPanels
List dashboard panels
DashboardPanels
List dashboard panels
List dashboard panels
GET
/
v1
/
dashboards
/
{dashboard_id}
/
panels
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards/%7Bdashboard_id%7D/panels?include=SOME_STRING_VALUE&page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "<string>",
"name": "<string>",
"params": {
"display": "line_chart",
"description": "<string>",
"table_fields": [
"<string>"
],
"legend": {
"groups": "all"
},
"datalabels": {
"enabled": true
},
"datasets": [
{
"name": "<string>",
"collection": "alerts",
"filter": [
{
"operation": "and",
"rules": [
{
"operation": "and",
"condition": "=",
"key": "<string>",
"value": "<string>"
}
]
}
],
"group_by": "<string>",
"aggregate": {
"operation": "count",
"key": "<string>",
"cumulative": true
}
}
]
},
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"data": [
{}
]
}
}
],
"links": {
"self": "<string>",
"first": "<string>",
"prev": "<string>",
"next": "<string>",
"last": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200 - application/vnd.api+json
success
Unique ID of the dashboard_panel
Available options:
dashboard_panels
Available options:
line_chart
, line_stepped_chart
, column_chart
, stacked_column_chart
, monitoring_chart
, pie_chart
, table
, aggregate_value
Available options:
all
, charted
Available options:
alerts
, incidents
, incident_post_mortems
, incident_action_items
, users
The panel dashboard
The name of the dashboard_panel
Was this page helpful?
curl --request GET \
--url 'https://api.rootly.com/v1/dashboards/%7Bdashboard_id%7D/panels?include=SOME_STRING_VALUE&page%5Bnumber%5D=SOME_INTEGER_VALUE&page%5Bsize%5D=SOME_INTEGER_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
{
"data": [
{
"id": "<string>",
"type": "dashboard_panels",
"attributes": {
"dashboard_id": "<string>",
"name": "<string>",
"params": {
"display": "line_chart",
"description": "<string>",
"table_fields": [
"<string>"
],
"legend": {
"groups": "all"
},
"datalabels": {
"enabled": true
},
"datasets": [
{
"name": "<string>",
"collection": "alerts",
"filter": [
{
"operation": "and",
"rules": [
{
"operation": "and",
"condition": "=",
"key": "<string>",
"value": "<string>"
}
]
}
],
"group_by": "<string>",
"aggregate": {
"operation": "count",
"key": "<string>",
"cumulative": true
}
}
]
},
"position": {
"x": 123,
"y": 123,
"w": 123,
"h": 123
},
"data": [
{}
]
}
}
],
"links": {
"self": "<string>",
"first": "<string>",
"prev": "<string>",
"next": "<string>",
"last": "<string>"
}
}