Get the List of Published Reports
GET /published-reports/ — Use this method to retrieve the list of reports published to the Business Intelligence (BI) Connector, with general information about each published report in the list.
This method does not return any published report data. It only returns general information about each report. For information about reading published report data, see Get a Published Report.
Reading the list of published reports using the REST API does not use any of your API request entitlement. It is only subject to BI Connector request frequency limits. Each API call using one of the following methods uses at least one BI Connector request. See BI Connector Request Limits.
The following conditions are required to access the /published-reports/ endpoint:
-
The Business Intelligence (BI) Connector feature is enabled for your SuiteProjects Pro account. To enable the BI Connector feature, contact your SuiteProjects Pro account manager.
For more information about the BI Connector, see Business Intelligence Connector Overview.
-
You must used an access token issued for the relevant scope (the scope must include
bi). For more information, see Authentication and OAuth 2.0 Authorization Code Flow.
You can access the published-reports endpoint even if API access and REST API are not enabled for your account.
Parameters
Path parameters
None
Query string parameter
None
Response definitions
A successful request returns a JSON object with the following properties:
|
Property |
Description |
|---|---|
|
|
An array containing objects with general information about each published report in the list requested. See Returned Data and Published report information object properties. |
|
|
A string containing a brief message about the status of your request — for example, |
A failed request returns a JSON object with the following properties:
|
Property |
Description |
|---|---|
|
|
A string containing a brief message about the status of your request. If the BI Connector feature is not enabled for your company's SuiteProjects Pro account, the REST API returns a HTTP Status |
Published report information object properties
A published report is a saved reports that have been published for access through the Business Intelligence (BI) Connector feature. When retrieving the list of published reports, the response includes general information about each report in the list (one object per published report).
The published report information object has the following properties:
|
Property |
Description |
Type |
Read-Only |
Query allowed |
Sorting allowed |
|---|---|---|---|---|---|
|
id |
The unique internal identifier for the published report. |
integer($int64) |
Yes |
— |
— |
|
lastPublished |
The date and time when the published report was last published or refreshed. |
string($date-time) |
Yes |
— |
— |
|
name |
The name of the published report. |
string |
Yes |
— |
— |
|
totalRows |
The number of rows of data in the published report. |
integer($int64) |
Yes |
— |
— |
Sample request
GET /rest/v1/published-reports/ HTTP/1.1
Host: company-id.app.netsuitesuiteprojectspro.com
Authorization: Bearer <OAuth2_access_token>
In the example, <OAuth2_access_token> is the OAuth 2.0 access token obtained for the client application connecting to BI Connector resources and issued for the relevant scope (the scope must include bi). See Authentication.
Sample response
{
"data": [
{
"lastPublished": "2024-07-11 08:57:14",
"totalRows": 467,
"name": "Employee Rate and Cost",
"id": 1
},
{
"lastPublished": "2024-07-11 08:57:44",
"totalRows": 245,
"name": "Example of Report",
"id": 10
},
{
"lastPublished": "2024-07-11 08:56:57",
"totalRows": 2456,
"name": "Project - User report",
"id": 7
}
],
"message": "success
}