Document toolboxDocument toolbox

Custom Reports Endpoint

Overview

Custom Reports are accessible from PCR-360’s API. This allows access for external systems or even from a web browser. Unlike other API Endpoints within PCR-360, the Custom Reports Endpoint is only available through GET calls.

API Request Format for Custom Reports

Below is the format for the GET Request to the Custom Reports Endpoint. Where [PCR-360 URL] is the web address to your Organization instance of PCR-360, [API KEY] is a valid API Key from within PCR-360 that has permission to access Custom Reports, and [REPORT IDENTIFIER] is the unique Report Identifier that can be found on the Admin > Reports > Custom Reports grid. The User can access the Report as an HTML or PDF file by supplying it to the call using the type as the [FORMAT].

[PCR-360 URL]/api/[API KEY]/rpt/[REPORT IDENTIFIER].[FORMAT]

Example:

https://pcr-360.com/api/abcdefg1234567/rpt/testReport.pdf

In addition, the User will need to add all required parameters for the report and any additional desired parameters the Report supports. The parameters and their values are sent using the paired format below.

?[PARAMETER 1]=[VALUE 1]&[PARAMETER 2]=[VALUE 2]&[PARAMETER 3]=[VALUE 3]

Example:

Custom Reports API Permissions

 

image-20240904-192643.png

 

 

The Custom Reports API allows for running and retrieving reports. Any API key with the granted Read Permission can retrieve a Custom Report. Any API key with the granted Write Permission can run a Custom Report.

 

Related pages