Modify Chart on Dashboard
  • 16 Oct 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Modify Chart on Dashboard

  • Print
  • Share
  • Dark
    Light

Modify Dashboard -> Add chart || Modify chart

Method for adding and changing charst on dashboards.

URL

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

Request Body

{
  "ops": [
    {
      "type": "modify",
      "obj": "chart",
      "dashboard_id": {{OBJ_ID}},
      "obj_id": {{CHART_ID}},
      "name": {{CHART_NAME}},
      "description": {{CHART_DESCRIPTION}},
      "obj_type": {{CHART_TYPE}},
      "series": [
        {
          "conv_id": {{CONV_ID}},
          "node_id": {{NODE_ID}},
          "title": {{NODE_TITLE}}
        },
        ...
      ],
      "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 modify
obj string + An object of request chart
dashboard_id number / number as string + An ID of Dashboard that you want to modify An ID of an existing Dashboard
obj_id string + An ID of Chart An ID of Chart on Dashboard with {{dashboard_id}}
obj_type string + A type of Chart table, funnel, column, pie
name string + A name of Chart Any valid string
description string - A Description of Chart Any valid string
series array + An array of Nodes, statistics of which you want to display
conv_id number + An ID of Process or State diagram where Node stored An ID of an existing Process/State Diagramm
node_id string + An ID of a Node that you want to get values An ID of an existing Node
title string + A title of Node to desctibe on chart legend Any valid string. Notice, that you cant override Node title here if you set it in process or state diagramm editor
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": "chart",
            "chart_id": "5f3d452f82ba960c30188781",
            "obj_id": 120715
        }
    ]
}
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 chart
obj_id number An ID of Dashboard where Chart stored An ID of an existing Dashboard
chart_id string An ID of modified Chart An ID of an existing Chart
Was This Article Helpful?