GetDashboard - TCN API

GetDashboard retrieves a dashboard by the given ID and orgID and fetches its associated panels

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

GetDashboardRequest used in GetDashboard rpc

application

enum<string>

application

optional

application retrieving the dashboard

Allowed values:

APPLICATION_UNSPECIFIEDAPPLICATION_AGENTAPPLICATION_BUSINESS_INTELLIGENCEAPPLICATION_DELIVERY_SERVICEAPPLICATION_DEV_TOOLSAPPLICATION_INTEGRATIONSAPPLICATION_LIST_MANAGEMENT_SERVICESAPPLICATION_NATURAL_LANGUAGE_COMPLIANCEAPPLICATION_OMNI_BOSSAPPLICATION_ORGANIZATIONAPPLICATION_ROOM_303APPLICATION_SCORECARDSAPPLICATION_SCRIPTSAPPLICATION_TICKETSAPPLICATION_VOICE_ANALYTICSAPPLICATION_WORK_FORCE_MANAGEMENTAPPLICATION_WORKFLOWSAPPLICATION_NEWSROOMAPPLICATION_CONTACTMANAGERAPPLICATION_WFO_AGENT_MANAGERAPPLICATION_KNOWLEDGE_BASEAPPLICATION_RULE_ENGINE

dashboard_id

string

dashboard_id

optional

unique ID of dashboard to retrieve

resource_id

string

resource_id

optional

resource id of the dashboard

Example

{
    "application": "APPLICATION_UNSPECIFIED",
    "dashboard_id": "string",
    "resource_id": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Dashboard contains all fields for a dashboard

layout

object (DashboardLayout)

layout

optional

layout of associated panels

panels

array[object (DashboardPanel) {5}]

panels

optional

location information for each panel

view

object (DashboardView)

view

optional

viewing params of dashboard

org_ids

array[string]

org_ids

optional

list of clients whose data will be viewed

type

optional

dashboard type, with type specific components

One of

historic

real_time

historic

HistoricConfig

required

Historic Dashboard type

dashboard_id

string

dashboard_id

optional

unique ID for this dashboard

title

string

title

optional

required dashboard title

description

string

description

optional

optional dashboard description

resource_id

string

resource_id

optional

resource id of the dashboard

standard_dashboard

boolean

standard_dashboard

optional

standard dashboard flag

Example

{
    "layout": {
        "panels": [
            {
                "panel_source": {
                    "insight_id": "string"
                },
                "row_length": 0,
                "column_length": 0,
                "row_start": 0,
                "column_start": 0
            }
        ]
    },
    "view": {
        "org_ids": [
            "string"
        ]
    },
    "type": {
        "historic": {
            "time_span_range": {
                "start": "1s",
                "end": "1s"
            }
        }
    },
    "dashboard_id": "string",
    "title": "string",
    "description": "string",
    "resource_id": "string",
    "standard_dashboard": true
}

🔴500Server Error