Sends a Watts report distribution immediately, or sends only the requesting user a test email
Use this endpoint for “send now” and “test to me”. Each recipient receives an email with a protected link to a
stored snapshot of the report; nothing is attached and no report is rendered by the server. Recipients are resolved from the
direct users and groups, and each snapshot uses that recipient’s data access. When testToMe is true, only the
requesting user receives the email and the run never blocks a real run. Only one real run of a distribution may be
active at a time (409 otherwise). Emails are sent asynchronously; check per-recipient status from the delivery endpoints.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| reportDistributionId | Unique numeric identifier of the Watts distribution to run. | integer (int32) | Required |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| testToMe | When true, only the requesting user receives the email. When false, every resolved recipient does. | boolean | Optional |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
WattsReportRunResponse
| Property | Description | Type |
|---|---|---|
| failed | The number of recipients whose snapshot could not be captured; they received no email. | integer (int32) |
| queuedForEmail | The number of recipients whose snapshot was stored and whose link email was queued. | integer (int32) |
| recipients | The number of recipient users resolved from the direct users and groups; zero means nothing was sent. | integer (int32) |
| runId | The unique numeric identifier of the distribution execution log created for this run. | integer (int32) |
| skippedNoData | The number of recipients skipped because the distribution only sends when there is data and their snapshot had none. | integer (int32) |
Example Response
{ "failed": 1, "queuedForEmail": 1, "recipients": 1, "runId": 1, "skippedNoData": 1
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.
409
Conflict
The request conflicts with the current state of the resource.