# reports_platforms_new_create

Triggers a new report generation.

If the report has been previously requested, it returns the status of the report.
Reports expire after a configured duration.

The request body should include:
- report_name: Name of the report to generate
- learner_id: (optional) ID of the learner to filter by
- course_id: (optional) ID of the course to filter by
- force: (optional) Force generation of a new report even if one exists
- filters: (optional) Additional filters for the report
- departments: (optional) Department IDs to filter by

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

## Path parameters:

  - `key` (string, required)

## Request fields (application/json):

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

  - `params` (object)
    Advanced report filtering. e,g: {'username': 'username1, username2' }

  - `query` (string)
    Advanced Query to run the report, supports SQL Like queries. 

e.g For date type filtering 
date_joined > '2021-01-01' 

See https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.query.html#pandas.DataFrame.query

## Response 200 fields (application/json):

  - `data` (object, required)

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

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

  - `data.state` (string)
    Report States

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

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

  - `data.owner` (string)
    Report Owner

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

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