Create ReportDashboard

POST

api

sys

reportdashboards

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/reportdashboards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "LayoutJson": "<string>",
  "RefreshIntervalSeconds": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "LayoutJson": "<string>",
    "RefreshIntervalSeconds": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    LayoutJson: '<string>',
    RefreshIntervalSeconds: 123
  })
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Request Body

Required Fields

integer

required

ID of the business that owns this dashboard.

string

required

Dashboard name.

string

required

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

required

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

Optional Fields

string

Optional description.

boolean

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

integer

User who created the dashboard (set automatically).

boolean

Shown first in the Dashboards library for this business.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/reportdashboards" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "LayoutJson": "",
    "RefreshIntervalSeconds": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdashboards',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      LayoutJson: '',
      RefreshIntervalSeconds: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/reportdashboards',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'LayoutJson': '',
        'RefreshIntervalSeconds': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the reportdashboard was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ReportDashboard was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create ReportDashboard

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/reportdashboards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "LayoutJson": "<string>",
  "RefreshIntervalSeconds": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "LayoutJson": "<string>",
    "RefreshIntervalSeconds": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    LayoutJson: '<string>',
    RefreshIntervalSeconds: 123
  })
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400