GET /api/v202610/wattsreportdistribution/{reportDistributionId}/run

Lists the most recent runs of one Watts report distribution with per-recipient delivery status

GetWattsReportDistributionRunsV202610 Permissions: DistributedReportsSettings (Manage)
Use this endpoint to audit when a distribution ran and whether each recipient was captured and emailed. Runs are newest first. Deliveries report lifecycle status, expiry and send time only; report name, format and capture time are omitted here, so use GET /api/v202610/wattsreportdelivery/{deliveryId} for those. To start a run, 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.

Path Parameters

Name Description Type Required
reportDistributionId Unique numeric identifier of the Watts distribution whose runs are listed. integer (int32) Required

Query Parameters

Name Description Type Required
maxRuns Maximum number of most-recent runs to return, from 1 to 100; defaults to 20. integer (int32) Optional

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

WattsReportRunHistoryResponse
Property Description Type
completedAt The UTC time the run settled. Null means the run is still in progress. string (date-time)
deliveries The per-recipient delivery outcomes for this run. Empty when no recipients were resolved. WattsReportDistributionDeliveryResponse[]
WattsReportDistributionDeliveryResponse properties
Property Description Type
capturedAt The capture time in UTC. Null means no immutable result has yet been captured. string (date-time)
deliveryId The unique numeric identifier of the per-recipient delivery. integer (int32)
errorMessage The user-safe failure description. Null means no failure has been recorded. string
expiresDate The UTC time after which the delivery link no longer grants file access. string (date-time)
recipientUserId The EnergyCAP user’s numeric identifier whose access scope was used to capture this file. integer (int32)
reportDistributionId The unique numeric identifier of the Watts distribution, not a saved Watts report identifier. integer (int32)
reportFormat The selected format: CSV, CSV Data Only, or Excel. string
reportName The frozen report title to display with the download. string
runId The unique numeric identifier of the distribution execution log that owns this delivery. integer (int32)
sentDate The UTC send time. Null means email has not been recorded as sent. string (date-time)
snapshotId The immutable capture GUID. Knowledge of this value alone does not grant access. string (uuid)
status The delivery lifecycle state. Captured means only the query snapshot exists; it does not mean a generated file is ready or emailed. string
errorMessage The user-safe run failure description. Null means no run-level failure was recorded. string
recipientCount The number of recipients resolved when the run began. integer (int32)
reportDistributionId The unique numeric identifier of the Watts distribution that was run. integer (int32)
runId The unique numeric identifier of the run. integer (int32)
startedAt The UTC time the run began. string (date-time)
status The run state: Running, TestRunning, NoRecipients, Completed, or CompletedWithErrors. string
Example Response application/json 
[
  {    "completedAt": "2026-11-12",    "deliveries": [
      {      "capturedAt": "2026-11-12",      "deliveryId": 1,      "errorMessage": "string",      "expiresDate": "2026-11-12",      "recipientUserId": 1,      "reportDistributionId": 1,      "reportFormat": "string",      "reportName": "string",      "runId": 1,      "sentDate": "2026-11-12",      "snapshotId": "string",      "status": "string"
    }
    ],    "errorMessage": "string",    "recipientCount": 1,    "reportDistributionId": 1,    "runId": 1,    "startedAt": "2026-11-12",    "status": "string"
  }
]
404 Not Found The requested resource was not found. Verify the ID or path is correct.