---
title: "How to Use the Reporting API"
url: "https://dm0bkdes5q7a2ls.productfruits.help/en/article/reporting-api"
language: "en"
last_updated: "2025-12-11T17:49:22.295Z"
---

# How to Use the Reporting API

A RESTful API is now available to programmatically access Spirion Sensitive Data Platform reporting data.

For any given Spirion Sensitive Data Platform 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 API Calls

**Download**

-   GET /reporting/Report/[Download](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/Download.htm)
-   Triggers the generation of a Zipped CSV for a given report ID

**Execute Query**

-   POST /reporting/Report/[ExecuteQuery](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/ExecuteQuery.htm)
-   Triggers the generation of a Zipped CSV for a given report ID

**Retrieve Object Inventory**

-   GET /reporting/Report/[GetObjectInventory](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/GetObjectInventory.htm)
-   Loads object inventory data.

**Retrieve Report Histories**

-   GET /reporting/Report/[GetReportHistories](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/GetReportHistories.htm)
-   Lists all reports where a zipped CSV file has already been generated

**Retrieve Stored Report Configuration**

-   GET /reporting/Report/[GetStoredReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/GetStoredReportConfiguration.htm)/{ID}
-   Returns the attributes that define the configuration of the provided Report ID

**Load Report Data**

-   POST /reporting/Report/[LoadReportData](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/LoadReportData.htm)
-   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](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/LoadReportPreviewData.htm)
-   Returns the first 100 rows for a report in JSON format

**Refresh Analytics Data**

-   POST /reporting/Report/[RefreshAnalyticsData](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/RefreshAnalyticsData.htm)
-   Manually triggers a refresh of the data warehouse that stores information for reports

**Remove Downloads**

-   DELETE /reporting/Report/[RemoveDownload](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/RemoveDownloads.htm)
-   Remove Generated Zipped CSVs in bulk

**Report Configuration**

-   POST /reporting/Report/[ReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/ReportConfiguration.htm)
-   -   Creates a new report definition based on a complete configuration specified using JSON
-   GET /reporting/Report/[ReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/getReportConfiguration.htm)
-   -   Returns the report configuration as JSON for a given report ID
-   PUT /reporting/Report/[ReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/putReportConfiguration.htm)
-   -   Updates the report configuration as JSON for a given report ID
-   DELETE /reporting/Report/[ReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/deleteReportConfiguration.htm)
-   -   Removes the report and its configuration for a given report ID
-   GET /reporting/Report/ReportConfiguration/[ReportConfiguration](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/getReportConfigurationDefault.htm)
-   -   Returns the framework of a report configuration
-   GET /reporting/Report/[Reports](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/getReports.htm)
-   -   Returns a list of Reports by Name and ID

**View Report Data**

-   POST /reporting/Report/[ViewReportData](https://docs.spirion.com/Content/Sensitive%20Data%20Platform/Platform/SDP%20RESTful%20API/Reporting/postViewReportData.htm)
-   Specifies a JSON definition within the request to report data in paged increments
-   Max. 1000 rows per page.