Get Chart
  • 16 Oct 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Get Chart

  • Print
  • Share
  • Dark
    Light

Get Chart

Method for getting chart settings of the dashboard.

URL

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

Request Body

{
  "ops": [
    {
      "type": "get",
      "obj": "chart",
      "obj_id": {{CHART_ID}},
      "dashboard_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 get
obj string + An object of request chart
obj_id string + An ID of Chart that you want to get current settings An ID of an existing Chart
dashboard_id number / number as string + An ID of Dashboard where Chart stored An ID of an existing Dashboard
company_id string - An ID of a Company An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "name": "Task Statuses",
            "description": "Task Statuse",
            "obj_type": "column",
            "series": [
                {
                    "title": "Open",
                    "conv_id": 783228,
                    "node_id": "5f2a5fd182ba96377a517008"
                },
                ....
            ],
            "obj_id": "5f3d452f82ba960c30188781",
            "dashboard_id": 120715,
            "company_id": "i404856373",
            "privs": [
                {
                    "type": "delete",
                    "list_obj": [
                        "all"
                    ]
                },
                ....
            ]
        }
    ]
}
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
name string A name of Chart ---
description string A Description of Chart ---
obj_type string A type of Chart table, funnel, column, pie
series array An array of Nodes, statistics of which displayed ---
title string A title of Node, desctibed on chart legend ---
conv_id number An ID of Process or State diagram where Node stored ---
node_id string An ID of a Node that used as dahboard metric ---
obj_id string An ID of Chart ---
dashboard_id number An ID of Dashboard ---
company_id string An ID of Company ---
privs array An array of users rights settings over Dashboard view, create, modify, delete
Was This Article Helpful?