---
title: "Generating Platform Reports"
slug: "generating-platform-reports"
updated: 2026-05-26T07:09:03Z
published: 2026-05-26T07:09:03Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plainid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Generating Platform Reports

Platform Reports provide downloadable snapshots of authorization objects across the PlainID Authorization Platform. Reports are generated through API calls and returned as secure PDF download links.

The reports help organizations review Policy organization, governance, and compliance-related classifications across Environments.

## Access and Permissions

Report generation is available at the Environment level.

Supported roles include:

- Environment Viewer and Admin
- Tenant Admin

Permissions are validated both when generating the report and when retrieving the download URL.

### Create a Report Request

A [`POST` request](https://www.postman.com/plainid/plainid-external/request/xilotnc/management-apis?action=share&creator=28089543) creates a Report ID generation request.

When the request is submitted:

- The platform validates the request.
- A unique `reportId` is generated.
- The report begins processing.
- Report metadata is returned.

Each request generates a new report ID.

### Retrieve the Report Download Link

A [`GET` request](https://www.postman.com/plainid/plainid-external/request/4lcymls/management-apis?action=share&creator=28089543) uses the `reportId` to retrieve the latest report metadata and a valid PDF download link.

This flow supports asynchronous report generation. If the report is still processing, the status indicates that generation is still in progress.

Download URLs are time-limited. If a link expires, a new download URL can be generated using the same `reportId`.

## Report Types

Reports are generated as a structured PDF document for operational review, governance analysis, and audit preparation.

- The `policies_by_attribute` report provides an Environment-level overview of Authorization Policies grouped by selected custom Attributes, such as regulatory or compliance classifications. The report contains:
  - A high-level distribution summary of Policy classifications.
  - Grouped Policy views based on selected Attribute values.
  - Policy metadata and associated application information.
  - Visibility into Policies that may not yet have assigned classifications.

## Report Lifecycle

| Item | Retention |
| --- | --- |
| Report file | 30 days |
| Download URL validity | 24 hours |

After the download URL expires, a new URL can be retrieved using the report ID.