Get one ReportDashboard

GET

api

sys

reportdashboards

{id}

Get one ReportDashboard

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/reportdashboards/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/reportdashboards/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/reportdashboards/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "LayoutJson": "<string>",
  "SchemaVersion": 123,
  "IsShared": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "TemplateKey": "<string>",
  "IsDefault": true,
  "RefreshIntervalSeconds": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A self-service reporting dashboard: an ordered grid of tiles that reference saved reports (report_definition) or built-in templates, with dashboard-level parameters (date range, locations) bound to each tile’s filters.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ReportDashboard-Read role.

Path Parameters

integer

required

The Id of the ReportDashboard record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportdashboards/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdashboards/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportdashboards/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business that owns this dashboard.

string

Dashboard name.

string

Optional description.

string

DashboardLayout JSON (version 1): { version, parameters: [{ id, type: date_range|business_scope|enum|text, label, default }], widgets: [{ id, kind: report|heading|text, reportDefinitionId?, templateKey?, title?, size: { w: 1-4, h: 1-3 }, bindings: { parameterId: fieldPath | ”*” }, visualizationOverride? }], refreshIntervalSeconds? }.

integer

Version of the LayoutJson schema.

boolean

Visible to every user of the business; when false only the owner sees it.

integer

User who created the dashboard (set automatically).

string

Display value for Owner.FullName..

string

Display value for Owner.Email..

string

Key of the built-in template this dashboard was copied from, if any.

boolean

Shown first in the Dashboards library for this business.

integer

Auto-refresh interval in seconds (0 = manual).

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "Description": null,
  "LayoutJson": "",
  "SchemaVersion": 0,
  "IsShared": false,
  "OwnerId": null,
  "OwnerFullName": null,
  "OwnerEmail": null,
  "TemplateKey": null,
  "IsDefault": false,
  "RefreshIntervalSeconds": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[email protected]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "ReportDashboard Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one ReportDashboard

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/reportdashboards/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/reportdashboards/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/reportdashboards/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "LayoutJson": "<string>",
  "SchemaVersion": 123,
  "IsShared": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "TemplateKey": "<string>",
  "IsDefault": true,
  "RefreshIntervalSeconds": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200