Email Trends Availability — GET /api/v1/reports/email-trends/availability
Email Trends Availability
Can the Trends report be emailed right now? The relay saved in Settings › Notifications must be enabled, have a host, and pass the offline egress gate (the recipients are judged when sending). Reads nothing of a project.
Endpoint: GET /api/v1/reports/email-trends/availability
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”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | EmailAvailability (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
Section titled “More details”- Group: Reports
- Operation ID:
email_trends_availability_api_v1_reports_email_trends_availability_get - Source code:
backend/app/routers/reports.py, line 234 - Specification: OpenAPI JSON