Reporting API

A RESTful API is now available to programmatically access SDP reporting data.

For any given SDP environment, this summary of calls is available by navigating to the Spirion Reporting REST API Swagger page:

• https://api.{env}-spirion.com/reporting/swagger/index.html

Available Calls

Download

• GET /reporting/Report/Download

• Triggers the generation of a Zipped CSV for a given report ID

Execute Query

• POST /reporting/Report/ExecuteQuery

• Triggers the generation of a Zipped CSV for a given report ID

Retrieve Object Inventory

• GET /reporting/Report/GetObjectInventory

• Loads object inventory data.

Retrieve Report Histories

• GET /reporting/Report/GetReportHistories

• Lists all reports where a zipped CSV file has already been generated

Retrieve Stored Report Configuration

• GET /reporting/Report/GetStoredReportConfiguration/{ID}

• Returns the attributes that define the configuration of the provided Report ID

Load Report Data

• POST /reporting/Report/LoadReportData

• Returns the most current data in JSON format for the provided Report ID in paged increments

• Max. 1000 rows per page

Load Report Preview Data

• POST /reporting/Report/LoadReportPreviewData

• Returns the first 100 rows for a report in JSON format

Refresh Analytics Data

• POST /reporting/Report/RefreshAnalyticsData

• Manually triggers a refresh of the data warehouse that stores information for reports

Remove Downloads

• DELETE /reporting/Report/RemoveDownload

• Remove Generated Zipped CSVs in bulk

Report Configuration

• POST /reporting/Report/ReportConfiguration

  • Creates a new report definition based on a complete configuration specified using JSON

• GET /reporting/Report/ReportConfiguration

  • Returns the report configuration as JSON for a given report ID

• PUT /reporting/Report/ReportConfiguration

  • Updates the report configuration as JSON for a given report ID

• DELETE /reporting/Report/ReportConfiguration

  • Removes the report and its configuration for a given report ID

• GET /reporting/Report/ReportConfiguration/ReportConfiguration

  • Returns the framework of a report configuration

• GET /reporting/Report/Reports

  • Returns a list of Reports by Name and ID

View Report Data

• POST /reporting/Report/ViewReportData

• Specifies a JSON definition within the request to report data in paged increments

• Max. 1000 rows per page.