Show Dashboard

Updated On 16 Oct 2020
2 Minutes To Read
Contributors

Print
Share
Dark

Light

Get Charts of Dashboard

Method for getting current charts of the dashboard.

URL

https://api.corezoid.com/api/2/json/{API_LOGIN}/{GMT_UNIXTIME}/{SIGNATURE}

Request Body

{
    "ops": [
        {
            "type": "show",
            "obj": "dashboard",
            "obj_id": {{DASHBOARD_ID}},
            "company_id": {{COMPANY_ID}}
        }
    ]
}

Parameter	Type	Required	Description	Possible value
ops	JSON Object	+	The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations	* The number is user-limited by RPS limit.
type	string	+	A request type	show
obj	string	+	An object of request	dashboard
obj_id	number / number as string	+	An ID of Dashboard	An ID of an existing Dashboard
company_id	string	-	An ID of a Company, where sharing object stored	An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "dashboard",
            "obj_id": 120715,
            "title": "Jira Tasks",
            "description": "Dashboard of Our Tasks",
            "time_range": {
                "timezone_offset": -180,
                "select": "lastMonth"
            },
            "favorite": false,
            "privs": [
                {
                    "type": "delete",
                    "list_obj": [
                        "all"
                    ]
                },
                ...
            ],
            "company_id": "i404856373",
            "chart_list": [
                {
                    "name": "New Chart",
                    "obj_id": "5f3e377482ba960c30206791",
                    "type": "table"
                },
                ...
            ],
            "folder_id": 0,
            "owner_id": 76369,
            "owner_login": "feviy86961@demail3.com",
            "owner_name": "Fedor Eviy",
            "grid": [
                {
                    "obj_id": "5f3e377482ba960c30206791",
                    "x": 0,
                    "y": 0,
                    "width": 4,
                    "height": 4
                },
                ...
            ]
        }
    ]
}

Parameter	Type	Description	Possible value
request_proc	string	The overall processing status of all transactions from the request	ok, error
ops	array	The list of request results
id	A request id	empty
proc	string	The processing status of a specific operation	ok, error
obj	string	An object of request	dashboard
obj_id	number	An ID of Dashboard	An ID of existing Dashboard
title	string	A name of Dashboard
description	string	A description of Dashboard
time_range	JSON Object	A settings of dashboard
timezone_offset	number	---
select	string	---	online, previous_hour, today, last10minute , lastHour, last24hour, lastWeek, lastMonth
favorite	boolean	A Favorite flag	true, false
privs	array	An array of users rights settings over Dashboard	view, create, modify, delete
company_id	string	An ID of an Company, where Dashboardy stored	An ID of existing Company
chart_list	array	An array of Charts on Dashboard
name	string	A Chart name
obj_id	string	An ID of Chart	An ID of existing Chart
type	string	A type of Chart	table, funnel, column, pie
folder_id	number	An ID of Folder, where Dashboard stored	An ID of existing Folder
owner_id	number	An ID of Dashboard owner	An ID of existing User
owner_login	string	An login of Dashboard owner
owner_name	string	An displayed name of Dashboard owner
grid	array	An array of Charts displaying placement
obj_id	string	An ID of Chart	An ID of existing Chart
x	number	A chart placement on X-axis	0-11
y	number	A chart placement on Y-axis	0-11
width	number	A chart width	0-12
height	number	A chart height	0-12

Was This Article Helpful?