You are viewing v3 of the Coralogix API. v5 is the current version. Go to the v5 reference

Get a dashboard

GEThttps://api.coralogix.com/mgmt/openapi/3/v1/dashboards/dashboards/{dashboard_id}

No description available

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

dashboard_id# stringrequired

Response

200400401500application/json

This is a response containing the requested dashboard

authorId#string
authorName#string
createdAt#date-time
createdOriginType#TokenOriginType

Possible values: [TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API]

dashboard#object
Dashboard represents the structure and configuration of a Coralogix Custom Dashboard.
oneOf
• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
dashboard.absoluteTimeFrame# object
dashboard.actions# object[]
dashboard.annotations# object[]
dashboard.description#string
A brief description or summary of the dashboard's purpose or content
Example: Sample description
dashboard.filters# object[]
dashboard.folderId# object
dashboard.folderPath# object
dashboard.id#string
A unique identifier of the dashboard
Example: GZLHSeqelCbD3I7HbIDtL
dashboard.layout# objectrequired
dashboard.name#stringrequired
The display name of the dashboard
Example: Example Name
dashboard.off#object
dashboard.slugName#string
A unique slug name serving as an alias for accessing the dashboard
Example: system-health-monitoring
dashboard.variables# object[]
dashboard.variablesV2# object[]
isLocked#boolean
lockerAuthorId#string
lockerName#string
updatedAt#date-time
updatedOriginType#TokenOriginType

Possible values: [TOKEN_ORIGIN_TYPE_UNSPECIFIED, TOKEN_ORIGIN_TYPE_USER, TOKEN_ORIGIN_TYPE_API]

updaterAuthorId#string
updaterName#string