Request Summary Report Export — POST /api/v1/reports/summary/exports

Request Summary Report Export

Download now, or queue a background export.

Endpoint: POST /api/v1/reports/summary/exports

Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.

Parameters

Name	In	Required	Type	Default	Description
format	query	yes	string		pdf or xlsx.
mode	query	no	string	window
background	query	no	boolean	false	Queue a background export even when the report is small.
project_id	query	yes	string		Project to read. Single-valued. Required: without it the request is refused with 422 ‘missing_parameter’ (All Projects is not supported here).
release_id	query	no	array of string or null		Repeatable (OR, at most 20): a release UUID or ‘unattributed’ for runs no release claims.
suite_name	query	no	array of string or null		Repeatable (OR, at most 50), 1-500 characters; matched case-insensitively on the effective suite.
days	query	no	integer	7	Window in days, 1-365.
X-API-Key	header	no	string or null		API key, as an alternative to the access token (see Authentication).

Request body

No request body.

Responses

Status	Meaning	Body
200	Successful Response	ReportExportRequestOut (application/json)
422	Validation Error	HTTPValidationError (application/json)

It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.

More details

• Group: Summary Report
• Operation ID: request_summary_report_export_api_v1_reports_summary_exports_post
• Source code: backend/app/routers/summary_report.py, line 178
• Specification: OpenAPI JSON