Search ReportDashboards

GET

api

sys

reportdashboards

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business that owns this dashboard.

string

Filter by dashboard name.

string

Filter by optional description.

string

Filter by 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

Filter by version of the LayoutJson schema.

boolean

Filter by visible to every user of the business; when false only the owner sees it.

integer

Filter by user who created the dashboard (set automatically).

string

Filter by display value for Owner.FullName..

string

Filter by display value for Owner.Email..

string

Filter by key of the built-in template this dashboard was copied from, if any.

boolean

Filter by shown first in the Dashboards library for this business.

integer

Filter by auto-refresh interval in seconds (0 = manual).

Range Filters

integer

Filter by version of the LayoutJson schema greater than or equal to this value.

integer

Filter by version of the LayoutJson schema less than or equal to this value.

integer

Filter by auto-refresh interval in seconds (0 = manual) greater than or equal to this value.

integer

Filter by auto-refresh interval in seconds (0 = manual) less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportdashboards?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdashboards?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportdashboards',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportdashboards?ReportDashboard_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdashboards?' + new URLSearchParams({
    ReportDashboard_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportdashboards',
    params={
        'ReportDashboard_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/reportdashboards?from_ReportDashboard_UpdatedOn=2025-01-01T00:00&to_ReportDashboard_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportdashboards?' + new URLSearchParams({
    from_ReportDashboard_UpdatedOn: '2025-01-01T00:00',
    to_ReportDashboard_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/reportdashboards',
    params={
        'from_ReportDashboard_UpdatedOn': '2025-01-01T00:00',
        'to_ReportDashboard_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ReportDashboard[]

The list of ReportDashboard records matching the query. See the Get one ReportDashboard endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each ReportDashboard. The following fields are not populated in the Records[] response: LayoutJson.To get all fields, fetch the full record using the Get one ReportDashboard endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "Description": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search ReportDashboards

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200