Get a Published Report

GET /published-reports/{id} — Use this method to retrieve the data in the published report with the specified internal ID.

This method does not return general information about the published report such as the report name and publication date and time. It only returns the published report data. To retrieve general information about this and other published reports, get the list of published reports. See Get the List of Published Reports.

Reading published report data 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.

Important:

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

Path parameter	Required / Optional	Description	Type
`{id}`	Required	The internal ID of the published report.	integer

Path parameter

Required / Optional

Description

Type

{id}

Required

The internal ID of the published report.

integer

Query string parameter

Path parameter	Required / Optional	Description	Type
`limit`	Optional	A limit on the length of the page. See Pagination.	integer
`offset`	Optional	A cursor for use in pagination. See Pagination.	integer

Path parameter

Required / Optional

Description

Type

limit

Optional

A limit on the length of the page. See Pagination.

integer

offset

Optional

A cursor for use in pagination. See Pagination.

integer

Response definitions

A successful request returns a JSON object with the following properties:

Property	Description
`data`	An array containing the published report data requested. See Returned Data. Each object in the array corresponds to a row in the published report. The published report data object properties are the same as the report columns. There is an object property for each column in the report.
`meta`	An object containing response metadata. The `meta` object may include information about: The page returned, the number of objects per page, the total number of pages and objects in the list, and links to other pages. See Pagination.
`message`	A string containing a brief message about the status of your request — for example, `“Success”`.

Property

Description

data

An array containing the published report data requested. See Returned Data.

Each object in the array corresponds to a row in the published report. The published report data object properties are the same as the report columns. There is an object property for each column in the report.

meta

An object containing response metadata. The meta object may include information about:

The page returned, the number of objects per page, the total number of pages and objects in the list, and links to other pages. See Pagination.

message

A string containing a brief message about the status of your request — for example, “Success”.

A failed request returns a JSON object with the following properties:

Property	Description
`message`	A string containing a brief message about the status of your request — for example, `“Report 24 not found”`. If the BI Connector feature is not enabled for your company's SuiteProjects Pro account, the REST API returns a HTTP Status `404 Not Found` and the message `"Page not found"`.

Property

Description

message

A string containing a brief message about the status of your request — for example, “Report 24 not found”.

If the BI Connector feature is not enabled for your company's SuiteProjects Pro account, the REST API returns a HTTP Status 404 Not Found and the message "Page not found".

Sample request

            GET /rest/v1/published-reports/1?limit=100 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": [
        {
            "Column1": "Value1onRow1",
            "Column2": "Value2onRow1",
            "Column3": "Value3onRow1",
            "Column4": "Value4onRow1",
            "Column5": "Value5onRow1",
            "Column6": "Value6onRow1",
            "Column7": "Value7onRow1"
        },
        {
            "Column1": "Value1onRow2",
            "Column2": "Value2onRow2",
            "Column3": "Value3onRow2",
            "Column4": "Value4onRow2",
            "Column5": "Value5onRow2",
            "Column6": "Value6onRow2",
            "Column7": "Value7onRow2"
        },
        {
                ...

        },
        {
            "Column1": "Value1onRow467",
            "Column2": "Value2onRow467",
            "Column3": "Value3onRow467",
            "Column4": "Value4onRow467",
            "Column5": "Value5onRow467",
            "Column6": "Value6onRow467",
            "Column7": "Value7onRow467"
        }
    ],
    "message": "success",
    "meta": {
        "rowsPerPage": 100,
        "totalPages": 5,
        "totalRows": 467,
        "links": [
            {
                "rel": "self",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/published-reports/1?limit=100"
            },
            {
                "rel": "next",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/published-reports/1?limit=100&offset=100"
            },
            {
                "rel": "last",
                "href": "https://company-id.app.netsuitesuiteprojectspro.com/rest/v1/published-reports/1?limit=100&offset=400"
            }
        ]
    }
}