Create Dashboard
  • 16 Oct 2020
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Create Dashboard

  • Print
  • Share
  • Dark
    Light

Create Dashbaord

Method for creating dashboards.

URL

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

Request Body

{
  "ops": [
    {
      "type": "create",
      "obj": "dashboard",
      "title": {{TITLE}},
      "description": {{DESCRIPTION}},
      "folder_id": {{PARENT_FOLDER}},
      "time_range": {
        "select": "online",
        "start": 1597847260,
        "stop": 1597847260,
        "timezone_offset": -180
      },
      "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 create
obj string + An object of request dashboard
title string + A Name of dashboard ---
description string - A description of dashboard Any valid string
folder_id number + An ID of folder where dashboard will by created An ID of an existing Folder
time_range JSON Object - A settings of dashboard
select string - --- online, previous_hour, today, last10minute , lastHour, last24hour, lastWeek, lastMonth
start number - The start date of the dashboard data, timestamp 1597847260
stop number - The end date of the dashboard data, timestamp 1597847260
timezone_offset number - --- -180
company_id string - An ID of a Company where dashboard will by created An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "proc": "ok",
            "obj": "dashboard",
            "obj_id": 120720
        }
    ]
}
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 created dashboard
Was This Article Helpful?