WHERE DO I START?
You are here:... (Miscellaneous) > API > Dashboards
  • Top ↑

Dashboards

The dashboards API allows you access to your dashboards.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of dashboards

This method will return a list of dashboards associated with a tenant.

Method GET URL https://api.app.netuitive.com/dashboards
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a dashboard

This method creates a dashboard.

Method POST URL https://api.app.netuitive.com/dashboards
Parameters Required/Optional Description
dashboard Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
created Optional The time the dashboard was created. This must be in ISO 8601 format.
creatorEmail Optional The email of the user who created the dashboard.
description Optional The description of the dashboard.
id Optional The ID of the dashboard.
layout Optional

Specifies the layout of the dashboard's row(s). Layout contains a single attribute:

  • contents (optional)
    • Array of JSON objects that correspond to each row on a dashboard. Within each JSON object there are several options:
      • widgets (optional), which contains IDs for the widgets within the row.
      • height (optional), which is the height setting for the row (small, medium, large, xlarge, or custom).
      • customHeight (optional, which corresponds to the custom height setting. This number is the height in pixels (px) for the row.
name Optional The name of the dashboard.
private Optional Whether the dashboard is public or private.
properties Optional

The properties for the dashboard. Properties contains several options:

  • timeRangeDuration (optional)
  • wrap (optional)
    • Whether the dashboard rows wrap.
updated Optional The time the dashboard was last updated. This must be in ISO 8601 format.
userId Optional The ID of the user who created the dashboard.
widgets Optional A list of the widgets that are contained in the dashboard.

Get all element detail dashboards

This method will return a list of element detail dashboards.

Method GET URL https://api.app.netuitive.com/dashboards/elementtype
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get dashboards for an element type

This method will return the element detail dashboards for a given element type.

Method GET URL https://api.app.netuitive.com/dashboards/elementtype/{type}
Parameters Required/Optional Description
type Required URL (path) parameter. The element type.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Delete a dashboard

This method will delete a given dashboard.

Method DELETE URL https://api.app.netuitive.com/dashboards/{id}
Important   Replace {id} in the above URL with the ID from any of your integrations.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the dashboard.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get dashboard by ID

This method will return a dashboard for the given ID.

Method GET URL https://api.app.netuitive.com/dashboards/{id}
Parameters Required/Optional Description
id Required URL (path) parameter. The ID for the dashboard.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Update a dashboard

This method will update a given dashboard.

Method PUT URL https://api.app.netuitive.com/dashboards/{id}
Parameters Required/Optional Description
id Required URL (path) parameter. The ID for the dashboard.
dashboard Required Body parameter; see below.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
created Optional The time the dashboard was created. This must be in ISO 8601 format.
creatorEmail Optional The email of the user who created the dashboard.
description Optional The description of the dashboard.
id Required The ID of the dashboard.
layout Optional

Specifies the layout of the dashboard's row(s). Layout contains a single attribute:

  • contents (optional)
    • Array of JSON objects that correspond to each row on a dashboard. Within each JSON object there are several options:
      • widgets (optional), which contains IDs for the widgets within the row.
      • height (optional), which is the height setting for the row (small, medium, large, xlarge, or custom).
      • customHeight (optional, which corresponds to the custom height setting. This number is the height in pixels (px) for the row.
name Required The name of the dashboard.
private Optional Whether the dashboard is public or private.
properties Optional

The properties for the dashboard. Properties contains several options:

  • timeRangeDuration (optional)
  • wrap (optional)
    • Whether the dashboard rows wrap.
updated Optional The time the dashboard was last updated. This must be in ISO 8601 format.
userId Optional The ID of the user who created the dashboard.
widgets Optional A list of the widgets that are contained in the dashboard.

Copy a dashboard

This method copies an existing dashboard.

Method POST URL https://api.app.netuitive.com/dashboards/{id}/copy
Parameters Required/Optional Description
id Required URL (path) parameter. The ID for the dashboard.
requestBody Required Body parameter.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
name Required The name of the dashboard.