Get one ReportDefinition

GET

api

sys

reportdefinitions

{id}

Get one ReportDefinition

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

import requests

url = "https://spaces.nexudus.com/api/sys/reportdefinitions/{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/reportdefinitions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "Folder": "<string>",
  "EntityName": "<string>",
  "VisualizationType": "<string>",
  "QueryJson": "<string>",
  "VisualizationJson": "<string>",
  "SchemaVersion": 123,
  "IsShared": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "TemplateKey": "<string>",
  "LastRunOn": "<string>",
  "RunCount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A saved self-service report: a ReportQuery JSON document plus a visualization. Use report_catalog to discover fields, report_query to test a query before saving it, and report_run to execute a saved report.

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 ReportDefinition-Read role.

Path Parameters

integer

required

The Id of the ReportDefinition record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business that owns this report.

string

Report name shown in the library.

string

Optional description of what the report shows.

string

Folder used to group reports in the library (e.g. Bookings, Billing).

string

Root entity of the query; derived from QueryJson on save.

string

Visualization type (table, number, bar, line, area, pie); derived from VisualizationJson on save.

string

ReportQuery JSON document (version 1). Use report_catalog to discover entities and field paths and report_query to test the query before saving..

string

VisualizationDocument JSON: { “type”: “table|number|bar|line|area|pie”, “settings”: { … } }.

integer

Version of the QueryJson schema.

boolean

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

integer

User who created the report (set automatically).

string

Display value for Owner.FullName..

string

Display value for Owner.Email..

string

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

string

UTC time the report was last run.

integer

Number of times the report has been run.

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,
  "Folder": null,
  "EntityName": null,
  "VisualizationType": null,
  "QueryJson": "",
  "VisualizationJson": null,
  "SchemaVersion": 0,
  "IsShared": false,
  "OwnerId": null,
  "OwnerFullName": null,
  "OwnerEmail": null,
  "TemplateKey": null,
  "LastRunOn": null,
  "RunCount": 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": "ReportDefinition Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one ReportDefinition

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

import requests

url = "https://spaces.nexudus.com/api/sys/reportdefinitions/{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/reportdefinitions/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "Folder": "<string>",
  "EntityName": "<string>",
  "VisualizationType": "<string>",
  "QueryJson": "<string>",
  "VisualizationJson": "<string>",
  "SchemaVersion": 123,
  "IsShared": true,
  "OwnerId": 123,
  "OwnerFullName": "<string>",
  "OwnerEmail": "<string>",
  "TemplateKey": "<string>",
  "LastRunOn": "<string>",
  "RunCount": 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