Retrieves status and metadata for one Watts report delivery by its delivery ID
Use this endpoint to show the report name, preselected export option, capture time and expiry before loading the data.
To load the captured rows, use GET /api/v202610/wattsreportdelivery/{deliveryId}/snapshot.
A delivery that belongs to another recipient, is expired or revoked, or does not exist all return 404.
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 |
|---|---|---|---|
| deliveryId | Unique numeric identifier of the per-recipient delivery, as carried by the emailed link. | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
WattsReportDistributionDeliveryResponse
| 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 |
Example Response
{ "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"
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.