Email Trends Report — POST /api/v1/reports/email-trends
Email Trends Report
Email the Trends report of one project (the page’s window, releases and suites) to project members and up to 5 typed addresses, through the relay saved in Settings › Notifications. One message for every recipient.
Endpoint: POST /api/v1/reports/email-trends
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA lead or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
application/json | EmailTrendsRequest | yes |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | EmailTrendsResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
502503504
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
Section titled “More details”- Group: Reports
- Operation ID:
email_trends_report_api_v1_reports_email_trends_post - Source code:
backend/app/routers/reports.py, line 157 - Specification: OpenAPI JSON