# reports_platforms_retrieve

Returns a list of reports available in the system.

For each report, it includes:
- display_name: Human-readable name of the report
- description: Description of what the report contains
- icon: URL to an icon representing the report
- report_name: Unique identifier for the report
- extra_query_params: Additional parameters that can be passed when creating the report
- result_columns: Columns that will be included in the report results
- status: Current status of the report if it has been previously requested

The status will include details like the report ID, state, and download URL if completed.

Endpoint: GET /api/reports/platforms/{key}/
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Path parameters:

  - `key` (string, required)

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.display_name` (string)
    Report Name

  - `data.description` (string)
    Report Description

  - `data.report_name` (string)
    Report slug

  - `data.icon` (string)

  - `data.extra_query_params` (array)
    Extra parameters to be passed to the report create view, e.g learner_id

  - `data.result_columns` (array)
    Columns to be available in the report

  - `data.status` (object)
    Report Status if any available

  - `data.status.report_id` (string)
    Used to download the report

  - `data.status.report_name` (string)
    Report slug, this is passed when calling the create report endpoint

  - `data.status.state` (string)
    Report States

*  - Pending
*  - Running
*  - Accumulating
*  - Processing
*  - Storing
*  - Completed
*  - Cancelled
*  - Error
*  - Expired
    Enum: "pending", "running", "accumulating", "processing", "storing", "completed", "cancelled", "error", "expired"

  - `data.status.started_on` (string)
    Report request timestamp (ISO 8601)

  - `data.status.owner` (string)
    Report Owner

  - `data.status.expires` (string)
    When report would expire and not available for download anymore

  - `data.status.url` (string)
    Download link for report when available