-
Print
-
DarkLight
-
PDF
Get Charts of Dashboard
Method for getting current Charts of a Dashboard.
URL

https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{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 using the 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",
"parent_obj_id": 0,
"parent_obj_type": "folder",
"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 | string | Request ID | empty |
proc | string | The processing status of a specific operation | ok, error |
obj | string | An object of request | dashboard |
obj_id | number | Dashboard ID | An ID of existing Dashboard |
title | string | Dashboard name | |
description | string | Dashboard description | |
parent_obj_id | number | ID of a parent object | |
parent_obj_type | string | Parent object type | folder |
time_range | JSON Object | Dashboard settings | |
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 the Company where a Dashboard is stored | An ID of existing Company |
chart_list | array | An array of Charts on a 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 the Folder where a Dashboard is stored | An ID of existing Folder |
owner_id | number | Dashboard owner ID | An ID of existing User |
owner_login | string | Dashboard owner login | |
owner_name | string | A displayed name of a Dashboard owner | |
grid | array | An array of Charts displaying placement | |
obj_id | string | Chart ID | An ID of existing Chart |
x | number | A Chart location on X-axis | 0-11 |
y | number | A Chart location on Y-axis | 0-11 |
width | number | Chart width | 0-12 |
height | number | Chart height | 0-12 |