Runs all Watts report distributions that are due according to their schedules
Use this endpoint from a scheduler to trigger due Watts distributions. The system report schedule runner user processes every
customer database’s distributions, as it does for standard distributions; any other caller needs DistributedReportsSettings Manage
and only processes their own database. A distribution is due on the same UTC calendar-day rules as standard distributions
(daily, weekly, monthly, quarterly). Only active distributions in a licensed database run, and a failure in one distribution
or database does not stop the others.
For one distribution on demand, use POST /api/v202610/wattsreportdistribution/{reportDistributionId}/run.
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. |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
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
}
]